Create automatic HA backup
system_create_backupCreates a quick Home Assistant backup with no extra parameters, using the instance's registered backup service; on Supervisor, automatic settings may prune older backups.
Instructions
Create a Home Assistant backup using whichever backup service the instance registers.
On Supervisor installs backup.create does not exist, so this calls
backup.create_automatic instead, which creates a backup using the
automatic-backup settings configured in Settings -> System -> Backups;
when a retention count is configured there, those same settings prune
older automatic backups as a side effect of this call. On HA
Core/Container installs, where backup.create exists, that one is
called instead — no name, folder selection or password. Returns an
error if neither service is registered.
Use when: HA already has the wanted automatic-backup settings configured
and a quick backup with no extra parameters is enough.
Not for: a named, partial, and/or password-protected backup on a
Supervisor install, or a backup that never deletes older ones — use
supervisor_create_backup.
Returns: the called service's result, or an error dict when neither
service is registered.
Errors: {"error": "Neither backup.create nor backup.create_automatic is registered on this Home Assistant instance."}.
Limits: on Supervisor installs, applies the instance's configured
retention count, which can delete older backups.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||