List snapshots

List sandbox snapshots for the authenticated tenant, with optional filtering, sorting, and pagination.

GET /v2/sandboxes/snapshots

Error

A valid request URL is required to generate request examples

200

{
  "offset": 123,
  "snapshots": [
    {
      "created_at": "<string>",
      "created_by": "<string>",
      "docker_image": "<string>",
      "fs_capacity_bytes": 123,
      "fs_used_bytes": 123,
      "id": "<string>",
      "image_digest": "<string>",
      "memory_snapshot_size_bytes": 123,
      "name": "<string>",
      "registry_id": "<string>",
      "source_sandbox_id": "<string>",
      "status": "<string>",
      "status_message": "<string>",
      "updated_at": "<string>"
    }
  ]
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Query Parameters

limit · integer · default: 50

Maximum number of results

offset · integer · default: 0

Pagination offset

name_contains · string

Filter by name substring

status · string

Filter by status (building, ready, failed, deleting)

created_by · string

Filter by creator identity. Only 'me' is supported.

sort_by · string · default: created_at

Sort column (name, status, created_at)

sort_direction · string · default: desc

Sort direction (asc, desc)

Response

200

application/json

OK

offset · integer

snapshots · object[]

Show child attributes