Sign in

v2

latestOpenAPI 3.0.02026-08-0688139156.5 KB
Snapshots

List snapshots

get/v1/snapshot

Query parameters

agent_idstring

ID of an agent

Example:a_0123456789ab
offsetinteger

Starting index for pagination

limitinteger

Number of items to return for pagination

snapshot_location'exists_local' | 'exists_cloud' | 'exists_deleted' | 'exists_deleted_retention' | 'exists_deleted_manual' | 'exists_deleted_other' | 'location_any'

Filter snapshots by location or deleted status.

Enum Values:

  • exists_local: Snapshots that exist on the local device storage
  • exists_cloud: Snapshots that exist in cloud storage
  • exists_deleted: Any deleted snapshots (includes all deletion types)
  • exists_deleted_retention: Snapshots deleted by retention policy
  • exists_deleted_manual: Snapshots manually deleted by users
  • exists_deleted_other: Snapshots deleted by other processes/systems
  • location_any: Snapshots in any location (local, cloud, including deleted)
  • If you do not specify a location, the default is local and cloud not including deleted.

Location of the snapshot, or if snapshot deleted state

backup_started_afterstring date-time

Filter snapshots created after a specific backup start time (RFC3339 format)

backup_started_beforestring date-time

Filter snapshots created before a specific backup start time (RFC3339 format)

backup_ended_afterstring date-time

Filter snapshots completed after a specific backup end time (RFC3339 format)

backup_ended_beforestring date-time

Filter snapshots completed before a specific backup end time (RFC3339 format)

sort_by'backup_start_time' | 'backup_end_time' | 'created'

Sort by a specific field

sort_ascboolean

Sort in ascending order

Response

OK

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "pagination": {
    "next_offset": 10
  }
}