The Backup integration allow you to create and download backups for your Home Assistant Core and Home Assistant Container installations. This backup file can be used if you migrate to Home Assistant Operating System.
If you use Home Assistant Operating System or Home Assistant Supervised, back up functionality is already built-in.
This integration is by default enabled, unless you’ve disabled or removed the
default_config: line from your configuration. If that is the case, the following example shows you how to enable this integration manually:
# Example configuration.yaml entry backup:
You need to restart Home Assistant after you add this configuration. When it has started up again you will find a new “Backup” entry in the main menu (Settings -> System -> Backup).
The backup files are stored in a new “backups” subdirectory in the root of your configuration directory.
The backup integration exposes a service that can be used to automate the backup process.
backup.create service can be used
to create a backup for your Home Assistant instance.
The service has no additional options or parameters.
Example service call:
This is a YAML example for an automation that initiate a backup every night at 3 AM:
automation: - alias: "Backup Home Assistant every night at 3 AM" trigger: platform: time at: "03:00:00" action: alias: "Create backup now" service: backup.create