Skip to content

Get restore run

GetRestoreRun

GetRestoreRun

Description: Returns one restore run by restore_id.

Access Control

SESSION_ADMIN, SESSION_MANAGER

Request Parameters

Field Type Required Description
restore_id string Yes Restore run identifier

Request Example

{
  "command": "GetRestoreRun",
  "extID": "1",
  "data": {
    "restore_id": "20260629-122000-000002"
  }
}

Response Example

{
  "restore_id": "20260629-122000-000002",
  "source_run_id": "20260629-121045-000001",
  "dry_run": false,
  "force": true,
  "pre_restore_path": "backups/pre-restore/20260629-122000-000002",
  "status": "completed",
  "started_at": 1782728400,
  "finished_at": 1782728405,
  "error_summary": "",
  "participants": [
    {
      "name": "trades",
      "critical": true,
      "ok": true,
      "status": "completed",
      "started_at": 1782728401,
      "finished_at": 1782728405,
      "error": "",
      "safety_snapshot_path": "backups/pre-restore/20260629-122000-000002",
      "artifacts": [],
      "safety_artifacts": [
        {
          "logical_name": "trades.db",
          "path": "backups/pre-restore/20260629-122000-000002/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 restore_id is missing or is not a string
RESTORE_RUN_NOT_FOUND 404 Restore run was not found