Backup endpoints

With these endpoints your app can make and restore backups, like a backup app that copies backups to another location. Your app needs hassio_api: true and the backup role, or the manager or admin role.

<backup> is the slug of a backup, a short random ID like a1b2c3d4.

A backup can be stored in more than one place. A location is one of:

• null or .local: the local backup folder of the system
• The name of a network mount that is used for backups
• .cloud_backup: Home Assistant Link. Only Home Assistant Core can use this location

Backups can include these folders: share, ssl, media, and addons/local (the local apps). The API also accepts apps/local for the local apps. In requests, the folder homeassistant means the same as homeassistant: true.

Returns the backups.

{
  "backups": [
    {
      "slug": "a1b2c3d4",
      "name": "Before the update",
      "date": "2026-10-01T09:30:00.000000+00:00",
      "type": "partial",
      "size": 0.17,
      "size_bytes": 178257,
      "location": null,
      "locations": [null],
      "protected": false,
      "location_attributes": {
        ".local": {
          "protected": false,
          "size_bytes": 178257
        }
      },
      "compressed": true,
      "content": {
        "homeassistant": false,
        "addons": ["core_mosquitto"],
        "folders": ["share"]
      }
    }
  ]
}

Returns the same list as GET /backups, plus the backup settings.

Reads all backup locations again, to pick up backup files that were added or removed outside of the Supervisor.

Makes a backup of everything: Home Assistant, all apps, and all folders.

When the backup is done, the response has the job_id and the slug of the new backup:

{
  "job_id": "e2b7a9c4f1d34e5a8b6c0d1e2f3a4b5c",
  "slug": "a1b2c3d4"
}

Makes a backup of the parts you choose. Takes all keys of POST /backups/new/full, plus:

{
  "name": "Mosquitto and share",
  "addons": ["core_mosquitto"],
  "folders": ["share"]
}

Uploads a backup file. Send the .tar file as multipart/form-data. Responds with the slug of the backup.

Returns the details of a backup.

Returns the backup as a .tar file. Use the location query parameter to pick the copy to download. Without it, you get the copy in the main location.

Deletes a backup.

Restores everything in the backup. Home Assistant and the apps restart during the restore.

Responds with the job_id of the restore.

Restores the parts you choose. Takes all keys of the full restore, plus:

Prepares the system for a backup made outside the Supervisor, like a snapshot of a virtual machine. Home Assistant and the running apps get ready for the backup, the same way they do for a normal one. Apps with backup: cold stop.

Ends a freeze. Home Assistant and the apps go back to normal.