Backup

The Backup integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] creates and restores backups across all installation types.

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

Actions

The Backup integration exposes actions you can use to automate the backup process.

However, you no longer need to create your own automation. You can set up an automatic backup from the UI instead.

Action: Create automatic

The backup.create_automatic action allows you 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.

Use this action to create backups with predefined settings on a more flexible schedule than the built-in automatic backup schedule.

The action has no additional options or parameters.

Example action:

action: backup.create_automatic

Action: Create

The backup.create action allows you 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 is only saved to local storage.
• The backup created with backup.create always includes the database.
• The backup is created without a password.

Example action:

action: backup.create

Example: Backing up every night at 3:00 AM

Here’s a YAML example of an automation that creates 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] that represents the state of the last automatic backup (completed, in progress, or failed). It also provides several event attributes you can use in automations.

Usage examples

Send a notification to the mobile app when an automatic backup fails:

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:
  - action: notify.mobile_app_your_phone
    data:
      title: "Automatic backup failed"
      message: >-
        The last automatic backup failed due to
        {{ state_attr('event.backup_automatic_backup', 'failed_reason') }}

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.