2.4 KiB
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. |
|
2022.4 | internal | backup |
|
Calculated | system |
|
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 actions that can be used to automate the backup process.
Action {% my developer_call_service service="backup.create_automatic" %}
The {% my developer_call_service service="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 {% my developer_call_service service="backup.create" %}
The {% my developer_call_service service="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.