Delete backup run
DeleteBackupRun¶
DeleteBackupRun
Alias: DeleteBackup
Description: Deletes a local backup run from the backup catalog and removes its stored artifact directory.
The command is intended for cleanup of completed or failed backup runs. It does not delete an active backup run.
Access Control¶
SESSION_ADMIN,SESSION_MANAGER
Request Parameters¶
| Field | Type | Required | Description |
|---|---|---|---|
run_id |
string | Yes | Backup run identifier |
Request Example¶
{
"command": "DeleteBackupRun",
"extID": "1",
"data": {
"run_id": "20260629-121045-000001"
}
}
Response Example¶
{
"ok": true,
"run_id": "20260629-121045-000001",
"deleted_path": "backups/completed/20260629-121045-000001"
}
Errors¶
| Error | HTTP Code | Description |
|---|---|---|
INVALID_DATA |
400 |
run_id is missing or is not a string |
BACKUP_RUN_NOT_FOUND |
404 |
No local backup run exists for run_id |
BACKUP_RUN_ACTIVE |
409 |
The requested backup run is currently active |
BACKUP_RUN_DELETE_FAILED |
409 |
The backup run could not be deleted |
Notes¶
The server validates the stored run path before deleting files. Only backup run directories under the local backup storage are eligible for deletion.