home-assistant.io/source/_integrations/backup.markdown

title, description, ha_category, ha_release, ha_quality_scale, ha_domain, ha_codeowners, ha_iot_class, ha_integration_type, related

title	description	ha_category	ha_release	ha_quality_scale	ha_domain	ha_codeowners	ha_iot_class	ha_integration_type	related
Backup	Allow creating backups of container and core installations.	Other	2022.4	internal	backup	@home-assistant/core	Calculated	system	docs title /common-tasks/general/#backups Backups docs title /getting-started/onboarding/ Recover from backup during onboarding docs title /more-info/backup-emergency-kit/ backup emergency kit

The Backup {% term integration %} 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 an action 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 {% my developer_call_service service="backup.create" %}

The {% my developer_call_service service="backup.create" %} action can be used to create a backup for your Home Assistant instance.

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.