---
title: "List snapshots"
method: GET
path: "/v1/snapshot"
tags: ["Snapshots"]
---

# List snapshots

`GET /v1/snapshot`

## Query parameters

- `agent_id` string — ID of an agent
- `offset` integer
- `limit` integer
- `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.
- `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` 'backup_start_time' | 'backup_end_time' | 'created'
- `sort_asc` boolean

## Response `200`

OK

- object — Paginated response
  - `data` Snapshot[], required — List of snapshots
    - `agent_id` string, required — ID of an agent
    - `backup_ended_at` string, date-time, required — End time of the backup that created the snapshot
    - `backup_started_at` string, date-time, required — Start time of the backup that created the snapshot
    - `deleted` string, date-time — Timestamp when the snapshot was deleted. If this field is not present, the snapshot has not been deleted.
    - `deletions` Deletion[] — List of deletion details
      - `deleted` string, date-time, required — Timestamp when the deletion occurred
      - `deleted_by` string, required — Name of the person or system that deleted the snapshot
      - `first_and_last_name` string — First and last name of a user
      - `type` 'local' | 'cloud', required — Type of the location
    - `locations` Location[], required — Location(s) of the snapshot. It will always exist in at least 1 location.
      - `device_id` string, required — ID of a device
      - `type` 'local' | 'cloud', required — Type of the location
    - `snapshot_id` string, required — ID of a snapshot
    - `verify_boot_duration_seconds` integer — 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_url` string, uri — URL to the screenshot of the boot verification. If this field is not present, that indicates a screenshot was not taken.
    - `verify_boot_status` 'success' | 'warning' | 'error' | 'skipped' | 'pending' | 'pending_due_to_disaster_vm' — 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.
  - `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)
