SFTP Storage

The SFTP Storage integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] works with the core Backup integration. When you enable SFTP Storage in the Locations section of your Backup integration settings, Home Assistant automatically stores manual and automatic backups on your remote SSH/SFTP server.

To learn how to create and restore a backup, refer to the backup section under common tasks.

Configuration

To add the SFTP Storage service to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & Services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select SFTP Storage.

  • Follow the instructions on screen to complete the setup.

Host

Hostname or IP address of SSH/SFTP Server to connect to.

Port

Port of your SSH/SFTP Server. This is usually 22.

Username

Username to authenticate with.

Password

Password to authenticate with. Provide this or a private key file.

Private Key File

Upload a private key file used for authentication. Provide this or password.

Remote path

Remote path where to upload backups. Directory must already exist and user provided in Username must have write access to it.

If both Password and Private Key File are provided, service will try to login with private key first, then fallback to password-based authentication if private key authentication fails.

Removing the integration

This integration follows standard integration removal. No extra steps are required.

To remove an integration instance from Home Assistant

  1. Go to Settings > Devices & services and select the integration card.
  2. From the list of devices, select the integration instance you want to remove.
  3. Next to the entry, select the three dots menu. Then, select Delete.
  • After you remove the integration, all Home Assistant backups stored on the remote server are not automatically deleted. You need to manually delete them from the remote filesystem.