Snapshots
Creates a memory snapshot. Linux sandboxes produce a full snapshot containing memory and disk; GPU sandboxes produce a checkpoint. Windows and macOS sandboxes return NOT_SUPPORTED_FOR_CLASS; to capture only the disk, create an image instead.
AuthorizationBearer <token>Bearer project API key.
Scope: write:snapshots
sandbox_id*stringThe sandbox ID
application/json- body
name*stringThe project-unique snapshot name.
Accepted: the sandbox snapshot capture
application/json- response
An accepted asynchronous operation.
id*stringThe ID of the resource the operation acts on.
status*stringThe resource's lifecycle status at acceptance.
curl -X POST 'https://example.com/sandboxes/string/snapshots' \ -H 'Content-Type: application/json' \ -d '{ "name": "string"}'{ "id": "string", "status": "string"}AuthorizationBearer <token>Bearer project API key.
Scope: read:snapshots
limit?integerMaximum number of items to return, 1–200 (default 100)
int641 <= value <= 200100cursor?stringOpaque continuation token returned as next_cursor by a previous request
name?stringMatch this exact snapshot name.
sandbox_id?stringReturn snapshots captured from this sandbox ID.
The page of snapshots
application/json- response
A page of snapshots.
next_cursor?|Opaque continuation token; null on the last page.
snapshots*array<>The snapshots in this page.
curl -X GET 'https://example.com/snapshots'{ "next_cursor": "string", "snapshots": [ { "available_in": [ "string" ], "bytes": 0, "class": "linux", "created_at": "2019-08-24T14:15:22Z", "error": "string", "id": "string", "kind": "full", "memory_bytes": 0, "name": "string", "region": "string", "sandbox_id": "string", "status": "string", "updated_at": "2019-08-24T14:15:22Z", "cursor": "string" } ]}AuthorizationBearer <token>Bearer project API key.
Scope: read:snapshots
id*stringThe snapshot ID or name
wait?stringBlock until the resource reaches this status or a terminal status. Omit to return immediately.
timeout_ms?integerMaximum time to block, in milliseconds. Default 30000, maximum 60000.
int640 <= valueid_only?booleanResolve the path value strictly as an ID, without a name fallback.
The snapshot
application/json- response
available_in*array<string>Every region where the snapshot is available.
bytes?|The disk size in bytes, or null until capture completes.
int64class*SnapshotClassThe sandbox class.
"linux""gpu"created_at*stringWhen the snapshot was created.
date-timeerror?|The failure detail, or null when capture has not failed.
id*stringThe snapshot ID.
kind*SnapshotKindThe snapshot kind. full captures memory and disk on Linux;
checkpoint captures a GPU sandbox.
"full""checkpoint"memory_bytes?|The memory size in bytes, or null for snapshots without memory state.
int64name*stringThe project-unique snapshot name.
region*stringThe home region.
sandbox_id?|The ID of the sandbox the snapshot was captured from, or null when that sandbox no longer exists.
status*stringThe snapshot status.
updated_at*stringWhen the snapshot was last updated.
date-timecurl -X GET 'https://example.com/snapshots/string'{ "available_in": [ "string" ], "bytes": 0, "class": "linux", "created_at": "2019-08-24T14:15:22Z", "error": "string", "id": "string", "kind": "full", "memory_bytes": 0, "name": "string", "region": "string", "sandbox_id": "string", "status": "string", "updated_at": "2019-08-24T14:15:22Z"}AuthorizationBearer <token>Bearer project API key.
Scope: delete:snapshots
id*stringThe snapshot ID or name
id_only?booleanResolve the path value strictly as an ID, without a name fallback.
Snapshot deleted
curl -X DELETE 'https://example.com/snapshots/string'