Restore from partial backup

Use this action to restore selected parts of a backup: Home Assistant settings, specific apps, and specific folders. This is handy when you only want to roll back one thing, for example a single app, without touching the rest of your system.

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 partial 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 partial backup.
6. Enter the Slug of the backup, choose what to restore, and optionally its Password.
7. Select Save.

Options in the UI

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

action: hassio.restore_partial
data:
  slug: 1f2e3d4c
  homeassistant: true

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

Options in YAML

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..
• If you restore Home Assistant settings, 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.

Related actions

These actions work well alongside this one:

• Restore from full backup: Restores from a full backup.

• Create a partial backup: Creates a partial backup.