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.

The automation editor does not show a UI editor because the action uses the same settings you defined under Settings > System > Backups, under Backup settings. For a more detailed description, refer to the documentation on 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.
• The backup will only be saved on the local storage.
• The backup created with backup.create always includes the database.
• The backup will be created without a password.

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.

Event entity

The Backup integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] provides an Event entityEvents are signals that are emitted when something happens, for example, when a user presses a physical button like a doorbell or when a button on a remote control is pressed. [Learn more] which represents the state of the last automatic backup (completed, in progress, failed). It also provides several event attributes which can be used in automations.

Usage examples

Send notification to mobile app, when an automatic backup failed.

alias: Backup failed
triggers:
  - trigger: state
    entity_id:
      - event.backup_automatic_backup
conditions:
  - condition: state
    entity_id: event.backup_automatic_backup
    attribute: event_type
    state: failed
actions:
  - data:
      title: Automatic backup failed
      message: The last automatic backup failed due to {{ state_attr('event.backup_automatic_backup', 'failed_reason') }}
    action: notify.mobile-app
mode: single

Sensors

The Backup integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] provides several sensors.

Backup Manager State

The current state of the backup system. Possible states are:

• Idle
• Creating a backup
• Receiving a backup
• Restoring a backup

Next scheduled automatic backup

The timestamp of the next scheduled automatic backup.

Last attempted automatic backup

The timestamp of the last attempted automatic backup.

Last successful automatic backup

The timestamp of the last successful automatic backup.