v2

latestOpenAPI 3.0.02026-08-0688139156.5 KB

Snapshots

Get snapshot

get/v1/snapshot/{snapshot_id}

Path parameters

snapshot_idstring required

ID of a snapshot

Example:s_0123456789ab

Response

agent_idstring required

ID of an agent

backup_ended_atstring date-time required

End time of the backup that created the snapshot

backup_started_atstring date-time required

Start time of the backup that created the snapshot

deletedstring date-time

Timestamp when the snapshot was deleted. If this field is not present, the snapshot has not been deleted.

snapshot_idstring required

ID of a snapshot

verify_boot_duration_secondsinteger

Duration of the boot verification in seconds, measured from VM power-on to the moment a successful boot was determined. Only present when verify_boot_status is success.

verify_boot_screenshot_urlstring uri

URL to the screenshot of the boot verification. If this field is not present, that indicates a screenshot was not taken.

Status of boot verification. If this field is not present, that indicates boot verification is pending.

verify_fs_status'success' | 'warning' | 'error' | 'skipped'

Status of filesystem verification. If this field is not present, that indicates filesystem verification is pending.

verify_service_status'success' | 'error' | 'skipped' | 'stopped'

Status of service verification. If this field is not present, that indicates service verification is pending.

Example response

{
  "agent_id": "a_0123456789ab",
  "backup_ended_at": "2024-08-23T01:40:08Z",
  "backup_started_at": "2024-08-23T01:25:08Z",
  "deleted": "2024-08-23T01:25:08Z",
  "deletions": [
    {
      "deleted": "2024-08-23T01:25:08Z",
      "first_and_last_name": "John Smith"
    }
  ],
  "locations": [
    {
      "device_id": "d_0123456789ab"
    }
  ],
  "snapshot_id": "s_0123456789ab",
  "verify_boot_duration_seconds": 95,
  "verify_boot_status": "success",
  "verify_fs_status": "success",
  "verify_service_status": "success"
}