Sign in

v2

latestOpenAPI 3.0.02026-08-0688139156.5 KB
Backups

Get backup

get/v1/backup/{backup_id}

Path parameters

backup_idstring required

ID of a backup attempt

Example:b_0123456789ab

Response

OK

agent_idstring required

ID of an agent

backup_idstring required

ID of a backup attempt

ended_atstring date-time

End time of the backup

error_codeinteger

Error code of the backup

error_messagestring

Human readable error message

snapshot_idstring

ID of the snapshot taken as part of the backup. If this field is not present, that indicates a snapshot was not taken.

started_atstring date-time required

Start time of the backup

status'created' | 'pending' | 'started' | 'preflight' | 'contacting' | 'creating_vss' | 'preparing' | 'transferring' | 'snapshot' | 'finalizing' | 'canceling' | 'failing' | 'canceled' | 'failed' | 'succeeded' required

Status of the backup

Example response

{
  "agent_id": "a_0123456789ab",
  "backup_id": "b_0123456789ab",
  "ended_at": "2024-08-23T01:40:08Z",
  "snapshot_id": "s_0123456789ab",
  "started_at": "2024-08-23T01:25:08Z",
  "status": "succeeded"
}