2026.6.3
Home ▸ Actions

Restore from full backup

Use this action to restore your system from a full backup. This replaces your current Home Assistant, apps, and their data with what is in the backup.

Caution

Restoring overwrites your current setup with the contents of the backup. Anything you changed after the backup was made is lost. Most people restore from the backup page in the UI rather than from an automation.

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 restore from a full 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 Restore from full backup.
  6. Enter the Slug of the backup to restore, and optionally its Password.
  7. Select Save.

Options in the UI

Slug (Required)

The slug of the backup to restore from.
Password (Optional)

The password of the backup, if it is password-protected.

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 hassio.restore_full. A basic example looks like this:

ActionActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*. [Learn more] 
action: hassio.restore_full
data:
  slug: 1f2e3d4c

You can find the slug of a backup under Settings > System > Backups.

Options in YAML

slug string Required

The slug of the backup to restore from.

password string

The password of the backup, if it is password-protected.

Good to know

  • Only administrators can run this action.
  • This action is only available when you run Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. or the Supervised installation method. It is not available on Home Assistant ContainerHome Assistant Container is a standalone container-based installation of Home Assistant Core. Any OCI compatible runtime can be used, but the documentation focus is on Docker. [Learn more] or Home Assistant CoreHome Assistant Core is the Python program at the heart of Home Assistant. It is part of all installation types. It can be installed standalone (without Home Assistant Supervisor) as a container using Docker (this is typically referred to as the Home Assistant Container installation type). For development, Core can also be run using a Virtual Environment (previously referred as the Home Assistant Core installation type). For production setup, the Home Assistant Core installation type is deprecated..
  • Home Assistant restarts as part of the restore, so it is unavailable for a while.

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.

Tip

AI assistants like ChatGPT or Claude can also explain actions or suggest the right one when you describe what you want in plain language.

Related actions

These actions work well alongside this one: