Backup for Home Assistant (built-in integration)

About

Backup is a built-in Home Assistant integration that creates backups and runs automatic backups locally. It provides actions to create a regular backup and to create one using the automatic backup settings. A sensor reports the state of the backup manager, and further sensors show the last attempted, last successful and next scheduled automatic backup. An event entity is fired for automatic backups. When an automatic backup has problems, such as missing apps or folders, errors during creation, or a failed upload to the configured locations, it shows a notice in Settings under Repairs. A diagnostics download is available to attach to bug reports, and setup is done in configuration.yaml.

Automatic summary of Home Assistant's source code. Something wrong? Get in touch

Supports

Works locally Talks to your devices on your own network. No vendor cloud in between.
Set up in YAML Added through configuration.yaml.
Updated with Home Assistant Ships and updates with every Home Assistant release.

Provides

Sensors

Setting it up

It is set up in configuration.yaml, not in the UI.

Entities

EventsAutomatic backup
SensorsBackup Manager state, Last attempted automatic backup, Last successful automatic backup, Next scheduled automatic backup

Actions

Create backupCreates a new backup.
Create automatic backupCreates a new backup with automatic backup settings.

Troubleshooting

DiagnosticsDownloads a diagnostics file to attach to a bug report.
Repair noticesNotices it can show in Settings, Repairs:Not all apps could be included in automatic backup, Automatic backup was created with errors, Automatic backup could not be created, Not all folders could be included in automatic backup, Automatic backup could not be uploaded to the configured locations