Delete remote backup run
DeleteRemoteBackupRun¶
DeleteRemoteBackupRun
Alias: DeleteRemoteBackup
Description: Deletes a backup run from a configured remote backup server endpoint.
Use this command to clean remote backup storage after confirming that the run is no longer needed.
Access Control¶
SESSION_ADMIN,SESSION_MANAGER
Request Parameters¶
| Field | Type | Required | Description |
|---|---|---|---|
server_name |
string | Yes | Backup endpoint name from GetBackupConfig |
run_id |
string | Yes | Remote backup run identifier |
Request Example¶
{
"command": "DeleteRemoteBackupRun",
"extID": "1",
"data": {
"server_name": "backup-eu-1",
"run_id": "20260629-121045-000001"
}
}
Response Example¶
{
"ok": true,
"server_name": "backup-eu-1",
"run_id": "20260629-121045-000001"
}
Errors¶
| Error | HTTP Code | Description |
|---|---|---|
INVALID_DATA |
400 |
server_name or run_id is missing or has invalid type |
REMOTE_BACKUP_RUN_NOT_FOUND |
404 |
The remote backup server does not have the requested run |
REMOTE_BACKUP_DELETE_FAILED |
409 |
The endpoint is missing, unavailable, unauthorized, does not support deletion, or returned an error |
Notes¶
The remote backup server must support the delete_run protocol command. Older
backup server binaries will reject the request as an unsupported command.