v2

latestOpenAPI 3.0.02026-08-0688139156.5 KB

Backups

List backups

Returns a paginated list of backups.

Backup record history details:

The last 10 backups will always be available.
Successful backups are removed when the related snapshot is removed.
Unsuccessful backups older than 30 days are removed.

get/v1/backup

Query parameters

agent_idstring

ID of an agent

Example:a_0123456789ab

snapshot_idstring

ID of a snapshot

Example:s_0123456789ab

device_idstring

ID of a device

Example:d_0123456789ab

offsetinteger

Starting index for pagination

limitinteger

Number of items to return for pagination

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'id' | 'start_time'

Sort by a specific field

sort_ascboolean

Sort in ascending order

Response

Example response

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