Import remote backup run

ImportRemoteBackupRun¶

ImportRemoteBackupRun

Description: Downloads a remote backup run from a configured backup server endpoint and publishes it into the local backup catalog.

After import, the run is available through GetBackupRun, ValidateBackupRun, and StartRestoreRun.

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
`overwrite`	bool	No	Replace an existing local run with the same `run_id`; default is `false`

Request Example¶

{
  "command": "ImportRemoteBackupRun",
  "extID": "1",
  "data": {
    "server_name": "backup-eu-1",
    "run_id": "20260629-121045-000001",
    "overwrite": false
  }
}

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": []
}

Restore Workflow¶

Call GetRemoteBackupRuns to choose a remote run_id.
Call ImportRemoteBackupRun.
Call ValidateBackupRun for the imported run_id.
Call StartRestoreRun when validation succeeds.

Errors¶

Error	HTTP Code	Description
`INVALID_DATA`	`400`	`server_name` or `run_id` is missing or invalid
`REMOTE_BACKUP_IMPORT_FAILED`	`409`	The remote run could not be downloaded, verified, or published locally