Create automatic backup

Use this action to create a backup using the settings you already configured for automatic backups. It backs up exactly what your scheduled backups do, including the same add-ons, folders, password, location, and retention, but it runs whenever you call it.

This is handy when you want an extra backup on your own schedule, on top of the built-in automatic backup, or right before you make a big change. You set up what goes into the backup once under Settings > System > Backups, in Backup settings, and this action reuses it.

This action is available on all installation types.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To create a backup from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. Search for and select Create automatic backup.
6. Select Save.

Options in the UI

This action has no options. It uses your configured backup settings.

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as backup.create_automatic. It takes no options:

action: backup.create_automatic

Options in YAML

This action has no options. It uses your configured backup settings.

Good to know

• This action follows everything you set under Backup settings, so it uploads to the same locations, applies the same password, and respects the same retention as your scheduled backups.
• Only administrators can run this action.
• The backup runs in the background. The action returns right away, before the backup finishes.

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup.

Automation: an extra backup every night

The built-in automatic backup already runs on a schedule. If you want a second safety copy at a different time, for example right before your nightly maintenance routine, you can trigger one yourself.

• Trigger: Time: 04:00
• Action: Create automatic backup

alias: "Extra nightly backup"
triggers:
  - trigger: time
    at: "04:00:00"
actions:
  - action: backup.create_automatic

Automation: a fresh backup before a Home Assistant update

When a new Home Assistant update appears, create a fresh backup right away. That way you always have a recent backup to fall back on before you install the update.

• Trigger: A Home Assistant update becomes available
• Action: Create automatic backup

alias: "Back up when an update is available"
triggers:
  - trigger: state
    entity_id: update.home_assistant_core_update
    to: "on"
actions:
  - action: backup.create_automatic

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Related actions

These actions work well alongside this one:

• Create backup: Creates a basic local backup of your Home Assistant instance.