---
title: "List backups"
method: GET
path: "/v1/backup"
tags: ["Backups"]
---

# List backups

`GET /v1/backup`

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.

## Query parameters

- `agent_id` string — ID of an agent
- `snapshot_id` string — ID of a snapshot
- `device_id` string — ID of a device
- `offset` integer
- `limit` integer
- `backup_started_after` string, date-time
- `backup_started_before` string, date-time
- `backup_ended_after` string, date-time
- `backup_ended_before` string, date-time
- `sort_by` 'id' | 'start_time'
- `sort_asc` boolean

## Response `200`

OK

- object — Paginated response
  - `data` Backup[], required — List of backups
    - `agent_id` string, required — ID of an agent
    - `backup_id` string, required — ID of a backup attempt
    - `ended_at` string, date-time — End time of the backup
    - `error_code` integer — Error code of the backup
    - `error_message` string — Human readable error message
    - `snapshot_id` string — ID of the snapshot taken as part of the backup. If this field is not present, that indicates a snapshot was not taken.
    - `started_at` string, 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
  - `pagination` Pagination, required
    - `next_offset` integer — Next offset to use for pagination. If this field is not present, that indicates there are no more items to fetch.

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `500` — Internal server error

---

[API](https://skmtc.net/slide/apis/slide-api.md) · [All operations](https://skmtc.net/slide/apis/slide-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/slide/slide-api/revisions/c63e4b604dd1/schema)
