Backup

The Backup integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] is used by all installation types to create and restore backups.

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

Actions

The Backup integration exposes actions that can be used to automate the backup process.

However, it is no longer needed to create your own automation. Follow these steps to set up an automatic backup from the UI.

Action backup.create_automatic

The backup.create_automatic action can be used to create a backup of your Home Assistant instance, using the same settings as those used by automatic backups.

This action can be called to create backups with pre-defined settings at a more flexible schedule than the schedule which can be configured for automatic backups.

The action has no additional options or parameters.

Example action:

action: backup.create_automatic

Action backup.create

The backup.create action can be used to create a backup of your Home Assistant instance. This action is only available in core and container installations. The action has no additional options or parameters. Example action:

action: backup.create

Example: Backing up every night at 3:00 AM

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"
    triggers:
      - trigger: time
        at: "03:00:00"
    actions:
      - alias: "Create backup now"
        action: backup.create

Restoring a backup

To restore a backup, follow the steps described in Restoring a backup.