backup

El dominio backup tiene 17 acciones. En la superficie meta se alcanzan todas a través de arcane_backup; en la individual, cada una es una herramienta propia; en la dinámica se ejecutan con arcane_execute_action y el ID canónico.

Resumen

Acción	Título	Tipo
backup.browse_files	Browse project files in an Arcane system backup	lectura
backup.create	Create Arcane system backup	escritura
backup.delete	Delete Arcane system backup	destructiva
backup.discover	Discover Arcane system backups in S3	escritura
backup.history	List unified backup history	lectura
backup.list	List Arcane system backups	lectura
backup.policies_get	Get Arcane system backup policies	lectura
backup.policies_update	Update Arcane system backup policies	escritura
backup.recovery_key_generate	Generate an Arcane system backup recovery key	lectura
backup.recovery_key_set	Configure Arcane system backup recovery key	destructiva
backup.restore	Restore Arcane system backup	destructiva
backup.restore_files	Restore project files from an Arcane system backup	destructiva
backup.upload_to_s3	Upload Arcane system backup	escritura
backup.volume_config_get	Get system-managed volume backup policies	lectura
backup.volume_config_update	Update system-managed volume backup policies	escritura
backup.volume_options	List volumes available to system-managed backups	lectura
backup.volume_run	Run system-managed volume backups	escritura

Acciones

backup.browse_files

Browse project files in an Arcane system backup

• Tipo: lectura
• Parámetros obligatorios: id, recoveryKey
• Meta-herramienta: arcane_backup con "action": "browse_files"
• Herramienta individual: arcane_backup_browse_files
• Ruta de Arcane: POST /api/backups/{id}/files/browse
• ID de operación: browse-system-backup-files
• Uso: Lists the project files inside a succeeded system backup (id from backup.list) one folder at a time: path is the folder relative to the backup root (empty for the top, where each project is a directory), search switches to a case-insensitive search over all paths, start/limit page. The recoveryKey field must be sent, but an empty string falls back to the stored key. Entries carry path, name and isDirectory, and the paths feed backup.restore_files. Failed backups are refused.
• Acciones relacionadas: backup.list, backup.restore_files

backup.create

Create Arcane system backup

• Tipo: escritura
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_backup con "action": "create"
• Herramienta individual: arcane_backup_create
• Ruta de Arcane: POST /api/backups
• ID de operación: create-system-backup
• Uso: Backs up Arcane itself (its SQLite database and projects directory, encrypted with the recovery key), not Docker volume data (volume_backup.create or backup.volume_run). destination is local (default), s3 or local_s3, the S3 ones with s3DestinationId from s3_destination.list. policyId runs a saved policy’s targets instead. recoveryKey may be omitted once one is stored (backup.recovery_key_set). Global admin only. Accepted in the background, it returns the run (id system-…, status running, activityId): poll backup.list until status is succeeded or failed. Only one system backup or system-managed volume run at a time. Refused unless Arcane uses the SQLite database provider. A containerised Arcane must also find its own container on the Docker host it manages, otherwise the accepted run fails (error could not detect Arcane container).
• Acciones relacionadas: backup.list, backup.recovery_key_set, s3_destination.list, backup.upload_to_s3, volume_backup.create

backup.delete

Delete Arcane system backup

• Tipo: destructiva — exige confirm: true
• Parámetros obligatorios: id
• Meta-herramienta: arcane_backup con "action": "delete"
• Herramienta individual: arcane_backup_delete
• Ruta de Arcane: DELETE /api/backups/{id}
• ID de operación: delete-system-backup
• Uso: Permanently deletes a system backup (id from backup.list): forgets its local and S3 snapshots and removes its record. recoveryKey is optional (the stored key is used), and a failed backup without snapshots needs no key at all. If a snapshot cannot be forgotten the record stays with the remaining one.
• Acciones relacionadas: backup.list, backup.history

backup.discover

Discover Arcane system backups in S3

• Tipo: escritura
• Parámetros obligatorios: recoveryKey, s3DestinationId
• Meta-herramienta: arcane_backup con "action": "discover"
• Herramienta individual: arcane_backup_discover
• Ruta de Arcane: POST /api/backups/discover
• ID de operación: discover-system-backups
• Uso: Imports the system backups found on an S3 destination (s3DestinationId from s3_destination.list) that this instance does not know yet, after a reinstall for example, as remote-… records in backup.list, and returns how many were added (0 when all are known). recoveryKey must be the key they were made with (empty uses the stored key). Volume backups are discovered with volume_backup.discover.
• Acciones relacionadas: s3_destination.list, backup.list, backup.restore, volume_backup.discover

backup.history

List unified backup history

• Tipo: lectura
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_backup con "action": "history"
• Herramienta individual: arcane_backup_history
• Ruta de Arcane: GET /api/backups/history
• ID de operación: list-backup-history
• Uso: One paginated list of every backup record: Arcane system backups and Docker volume backups of all volumes, each with resourceType (system or volume) and resourceName (Arcane or the volume name). type filters by origin: system (system backups plus volume backups made by system-managed policies or backup.volume_run) or volume (per-volume backups from volume_backup.*). search matches id, status, trigger, destination, error, resource name or type. Use it to follow backup.volume_run results.
• Acciones relacionadas: backup.list, backup.volume_run, volume_backup.list

backup.list

List Arcane system backups

• Tipo: lectura
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_backup con "action": "list"
• Herramienta individual: arcane_backup_list
• Ruta de Arcane: GET /api/backups
• ID de operación: list-system-backups
• Uso: Paginated Arcane system backups (id system-…, or remote-… when imported by backup.discover) with status (running, succeeded, failed), trigger (manual, scheduled, safety), destination, localSnapshotId/remoteSnapshotId, policyId and error. The id feeds backup.browse_files, backup.restore, backup.upload_to_s3 and backup.delete. search matches status, trigger, destination or error. Volume backups are not here: use backup.history.
• Acciones relacionadas: backup.create, backup.history, backup.browse_files, backup.restore, backup.delete

backup.policies_get

Get Arcane system backup policies

• Tipo: lectura
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_backup con "action": "policies_get"
• Herramienta individual: arcane_backup_policies_get
• Ruta de Arcane: GET /api/backups/policies
• ID de operación: get-system-backup-policies
• Uso: Scheduled system backup policies (id, enabled, schedule, retentionCount, localEnabled, s3Enabled, s3DestinationId, lastRun) and whether a recovery key is stored (recoveryKeyStored). Read it before backup.policies_update, which replaces the whole list.
• Acciones relacionadas: backup.policies_update, backup.recovery_key_set, backup.list

backup.policies_update

Update Arcane system backup policies

• Tipo: escritura
• Parámetros obligatorios: policies
• Meta-herramienta: arcane_backup con "action": "policies_update"
• Herramienta individual: arcane_backup_policies_update
• Ruta de Arcane: PUT /api/backups/policies
• ID de operación: update-system-backup-policies
• Uso: Replaces the whole list of scheduled system backup policies: keep a policy by sending its id from backup.policies_get, add one by omitting id. Omitted policies are deleted ([] removes them all). Each needs enabled, schedule (six-field cron with seconds, e.g. 0 0 3 * * *), retentionCount (succeeded backups kept, 0-3650, 0 keeps all), localEnabled and/or s3Enabled, plus s3DestinationId when s3Enabled. Enabling needs a stored recovery key. An enabled policy becomes job system-backup:<policyId>, runnable now with job.run.
• Acciones relacionadas: backup.policies_get, backup.recovery_key_set, s3_destination.list, job.run

backup.recovery_key_generate

Generate an Arcane system backup recovery key

• Tipo: lectura
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_backup con "action": "recovery_key_generate"
• Herramienta individual: arcane_backup_recovery_key_generate
• Ruta de Arcane: POST /api/backups/recovery-key/generate
• ID de operación: generate-system-backup-recovery-key
• Uso: Only returns a fresh random recoveryKey (8 dash-separated groups of 6 characters). Nothing is stored until backup.recovery_key_set. Give the key to the user to keep: system and volume backups cannot be opened without it.
• Acciones relacionadas: backup.recovery_key_set, backup.policies_get

backup.recovery_key_set

Configure Arcane system backup recovery key

• Tipo: destructiva — exige confirm: true
• Parámetros obligatorios: recoveryKey
• Meta-herramienta: arcane_backup con "action": "recovery_key_set"
• Herramienta individual: arcane_backup_recovery_key_set
• Ruta de Arcane: PUT /api/backups/recovery-key
• ID de operación: set-system-backup-recovery-key
• Uso: Stores the recovery key (from backup.recovery_key_generate, other formats are refused) that encrypts system and volume backups, and is needed before enabling scheduled system backups. Replacing a stored key with a different one is refused while system or volume backups exist, since they open only with the key that made them. Returns configured true, and backup.policies_get reports recoveryKeyStored.
• Acciones relacionadas: backup.recovery_key_generate, backup.policies_get

backup.restore

Restore Arcane system backup

• Tipo: destructiva — exige confirm: true
• Parámetros obligatorios: id, recoveryKey
• Meta-herramienta: arcane_backup con "action": "restore"
• Herramienta individual: arcane_backup_restore
• Ruta de Arcane: POST /api/backups/{id}/restore
• ID de operación: restore-system-backup
• Uso: Rolls the whole Arcane instance back to a succeeded system backup (id from backup.list): takes a local safety backup, then a helper container stops Arcane, replaces its database and projects and restarts it, so Arcane is unreachable for a while and everything created since the backup (settings, S3 destinations, projects…) is gone. Returns once the helper has started. Global admin only. Needs Arcane running in Docker with /app/data mounted, and recoveryKey must be sent (empty uses the stored key). For single project files use backup.restore_files.
• Acciones relacionadas: backup.list, backup.restore_files, backup.create

backup.restore_files

Restore project files from an Arcane system backup

• Tipo: destructiva — exige confirm: true
• Parámetros obligatorios: id, recoveryKey
• Meta-herramienta: arcane_backup con "action": "restore_files"
• Herramienta individual: arcane_backup_restore_files
• Ruta de Arcane: POST /api/backups/{id}/restore-files
• ID de operación: restore-system-backup-files
• Uso: Overwrites selected project files in Arcane’s projects directory with their copies from a succeeded system backup, after taking a safety backup. Arcane’s database is not touched. Select with paths (from backup.browse_files), or selectAll (not with paths), optionally narrowed by search. recoveryKey must be sent (empty uses the stored key). A restored directory is mirrored, so files added to it since the backup are deleted (selectAll without search does this to the whole projects directory). Waits for the restore to finish and rolls back on failure. Entries that contain Arcane’s data directory are refused.
• Acciones relacionadas: backup.browse_files, backup.list, backup.restore, project.get

backup.upload_to_s3

Upload Arcane system backup

• Tipo: escritura
• Parámetros obligatorios: id, recoveryKey, s3DestinationId
• Meta-herramienta: arcane_backup con "action": "upload_to_s3"
• Herramienta individual: arcane_backup_upload_to_s3
• Ruta de Arcane: POST /api/backups/{id}/upload
• ID de operación: upload-system-backup
• Uso: Copies a succeeded system backup that has a local snapshot (id from backup.list) to an S3 destination (s3DestinationId from s3_destination.list). recoveryKey must be sent (empty uses the stored key). Waits for the copy and returns the run with remoteSnapshotId and destination local_s3. A backup already uploaded is refused.
• Acciones relacionadas: backup.list, s3_destination.list, backup.discover

backup.volume_config_get

Get system-managed volume backup policies

• Tipo: lectura
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_backup con "action": "volume_config_get"
• Herramienta individual: arcane_backup_volume_config_get
• Ruta de Arcane: GET /api/backups/volumes/config
• ID de operación: get-system-volume-backup-config
• Uso: System-managed volume backup policies, each selecting many volumes at once (unlike the per-volume policies of volume_backup.policy_get): id, enabled, schedule, retentionCount, stopContainers, local/S3 targets, selectionMode, volumeNames, ignoreAnonymous and lastRun. Read it before backup.volume_config_update, which replaces the whole list. An id feeds backup.volume_run policyId.
• Acciones relacionadas: backup.volume_config_update, backup.volume_run, volume_backup.policy_get

backup.volume_config_update

Update system-managed volume backup policies

• Tipo: escritura
• Parámetros obligatorios: policies
• Meta-herramienta: arcane_backup con "action": "volume_config_update"
• Herramienta individual: arcane_backup_volume_config_update
• Ruta de Arcane: PUT /api/backups/volumes/config
• ID de operación: update-system-volume-backup-config
• Uso: Replaces the whole list of system-managed volume backup policies: keep one by sending its id from backup.volume_config_get, add one by omitting id. Omitted policies are deleted ([] removes them all). Each selects volumes with selectionMode all, allowlist or blocklist plus volumeNames (from backup.volume_options) and ignoreAnonymous, and needs enabled, schedule (six-field cron with seconds), retentionCount, localEnabled and/or s3Enabled (with s3DestinationId). stopContainers stops the volumes’ containers during the backup. Volumes with an enabled per-volume policy (volume_backup.policy_update) are skipped. An enabled policy becomes job system-backup:volumes:<policyId>.
• Acciones relacionadas: backup.volume_config_get, backup.volume_options, backup.volume_run, volume_backup.policy_update

backup.volume_options

List volumes available to system-managed backups

• Tipo: lectura
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_backup con "action": "volume_options"
• Herramienta individual: arcane_backup_volume_options
• Ruta de Arcane: GET /api/backups/volumes/options
• ID de operación: list-system-volume-backup-options
• Uso: Volume names a system-managed volume backup policy or backup.volume_run can select: the local Docker volumes minus internal ones and Arcane’s own, each with anonymous, plus names saved in policies that no longer exist (available false, skipped by runs).
• Acciones relacionadas: backup.volume_config_update, backup.volume_run, volume.list

backup.volume_run

Run system-managed volume backups

• Tipo: escritura
• Parámetros obligatorios: ninguno
• Meta-herramienta: arcane_backup con "action": "volume_run"
• Herramienta individual: arcane_backup_volume_run
• Ruta de Arcane: POST /api/backups/volumes/run
• ID de operación: run-system-volume-backups
• Uso: Backs up many local Docker volumes now, from either policyId (backup.volume_config_get) or custom {destination local|s3|local_s3, s3DestinationId, stopContainers, selectionMode, volumeNames, ignoreAnonymous}, not both. With neither it backs up every non-anonymous volume locally. Runs in the background and returns activityId (follow with activity.get in environment 0). Each volume’s backup then appears in backup.history with type system. Volumes with an enabled per-volume policy (volume_backup.policy_update) are skipped. Refused while a system backup or another such run is in progress.
• Acciones relacionadas: backup.volume_options, backup.volume_config_get, backup.history, activity.get, volume_backup.create