Create a Supervisor backup
supervisor_create_backupCreate a named Supervisor backup, full, partial, or password-protected, without deleting any existing backups.
Instructions
Create a new Supervisor backup, full or partial.
Calls POST /backups/new/full when neither addons nor folders is
given, otherwise POST /backups/new/partial with those slugs/folders.
Unlike system_create_backup, this never deletes older backups — it
only adds a new one.
Use when: a named, partial and/or password-protected backup is needed on
a Supervisor install.
Not for: a quick backup using the instance's own automatic-backup
settings (which may prune old ones) — use system_create_backup.
Returns: Supervisor's backup-job result, including the new backup's
slug on success.
Errors: {"error": "SUPERVISOR_TOKEN not set — Nexus must run as HA add-on for Supervisor API"} when the token env var is missing;
{"error": "HTTP <status>", "detail": ...} on a timeout or failure —
check supervisor_list_backups before retrying.
Limits: a full backup can take minutes; on a timeout error, check
supervisor_list_backups before retrying rather than assuming failure.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Human-readable name to store on the new backup. | |
| addons | No | Add-on slugs to include for a partial backup. Omit together with `folders` for a full backup of everything. | |
| folders | No | Folder names to include for a partial backup, e.g. 'share', 'ssl', 'media', 'addons/local'. Omit together with `addons` for a full backup of everything. | |
| password | No | Password to encrypt the backup with. Omit for an unencrypted backup. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||