Skip to main content
GET
List a sandbox's snapshots

Authorizations

X-API-Key
string
header
required

Path Parameters

sandbox_id
string
required

The unique identifier of the sandbox. Public sandbox ID: a bare UUID, or the region-tagged form sb-<region>-<uuid> (e.g. sb-use-1b4e28ba-…). Treat as an opaque string; the tagged form routes the request to the sandbox's home region. Endpoints accept both forms interchangeably.

Pattern: ^(sb-[a-z0-9]+-)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

limit
integer

Maximum rows to return (page size). Omit to return the full list unpaginated — the default, preserved for backward compatibility with callers that page client-side. Values above 200 are clamped to 200.

Required range: 1 <= x <= 200
offset
integer
default:0

Rows to skip before the page. Combine with limit to paginate.

Required range: x >= 0

Response

Snapshots, newest first

id
string<uuid>
required
sandbox_id
string<uuid>
required

The sandbox the snapshot was taken from. It may since have been deleted.

kind
enum<string>
required
Available options:
mem+fs
status
enum<string>
required
Available options:
creating,
ready,
failed,
deleting
size_bytes
integer<int64>
required

Bytes the snapshot holds on disk; 0 until ready.

resources
object
required
created_at
string<date-time>
required
template_id
string<uuid> | null

The template the captured sandbox was created from.

name
string | null
ready_at
string<date-time> | null