Skip to content

Get backup run

GetBackupRun

GetBackupRun

Description: Returns one backup run by run_id.

Access Control

SESSION_ADMIN, SESSION_MANAGER

Request Parameters

Field Type Required Description
run_id string Yes Backup run identifier

Request Example

{
  "command": "GetBackupRun",
  "extID": "1",
  "data": {
    "run_id": "20260629-121045-000001"
  }
}

Response Data

Field Type Description
run_id string Backup run identifier
type string Backup type: full or scoped
trigger string manual, cron, pre_update, or shutdown
status string running, completed, failed, partial, cancelled, or timeout
path string Backup run directory
started_at int Unix timestamp
finished_at int Unix timestamp, 0 while running
error_summary string Run-level error summary
requested_participants array Requested participant names for scoped backup; empty for full backup
participants array Participant result objects

Participant fields:

Field Type Description
name string Participant name
critical bool Whether participant failure fails the whole run
ok bool Participant success flag
status string completed or failed
started_at int Unix timestamp
finished_at int Unix timestamp
error string Participant error
artifacts array Produced artifacts

Artifact fields:

Field Type Description
logical_name string Logical artifact name, for example accounts.snapshot
path string Artifact path
size_bytes int Artifact size in bytes
sha256 string SHA-256 checksum
integrity_ok bool Artifact integrity check result
integrity_error string Integrity check error
validation_ok bool Overall validation result
validation_error string Validation error text

Response Example

{
  "run_id": "20260629-121045-000001",
  "type": "full",
  "trigger": "manual",
  "status": "completed",
  "path": "backups/completed/20260629-121045-000001",
  "started_at": 1782727845,
  "finished_at": 1782727852,
  "error_summary": "",
  "requested_participants": [],
  "participants": [
    {
      "name": "trades",
      "critical": true,
      "ok": true,
      "status": "completed",
      "started_at": 1782727848,
      "finished_at": 1782727852,
      "error": "",
      "artifacts": [
        {
          "logical_name": "trades.db",
          "path": "backups/completed/20260629-121045-000001/trades.db",
          "size_bytes": 1048576,
          "sha256": "9d10...",
          "integrity_ok": true,
          "integrity_error": "",
          "validation_ok": true,
          "validation_error": ""
        }
      ]
    }
  ]
}

Errors

Error HTTP Code Description
INVALID_DATA 400 run_id is missing or is not a string
BACKUP_RUN_NOT_FOUND 404 Run was not found