Snapshots
Creates a Linux memory snapshot containing memory and disk (full). macOS returns NOT_SUPPORTED_FOR_CLASS; create an image to capture its disk instead.
AuthorizationBearer <token>Bearer project API key.
Scope: write:snapshots, write:sandboxes
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": [ { "bytes": 0, "class": "linux", "created_at": "2019-08-24T14:15:22Z", "error": "string", "id": "string", "kind": "full", "memory_bytes": 0, "name": "string", "region_id": "string", "region_ids": [ "string" ], "sandbox_id": "string", "status": "string", "updated_at": "2019-08-24T14:15:22Z", "cursor": "string" } ]}Searches the project's snapshots using the supplied filters. Results may be briefly stale after a change.
AuthorizationBearer <token>Bearer project API key.
Scope: read:snapshots
q?stringFree text over the snapshot name. A value that is a snapshot ID matches that snapshot exactly.
name?stringMatch this exact snapshot name.
name_prefix?stringname starts with this string (case-sensitive).
status?array<>Comma-separated capture statuses. An unrecognized value answers 400.
class?array<>Comma-separated sandbox classes.
kind?array<>Comma-separated snapshot kinds.
region_ids?stringComma-separated home region IDs. A broader region (a geo group, or
earth) matches every region inside it. An unknown region answers
400. Defaults to every region.
sandbox_id?stringSnapshots captured from this sandbox ID.
created_start_at?stringInclusive lower bound on creation time.
date-timecreated_end_at?stringExclusive upper bound on creation time.
date-timeupdated_start_at?stringInclusive lower bound on last-modified time.
date-timeupdated_end_at?stringExclusive upper bound on last-modified time.
date-timesort?stringSort field. Defaults to created_at; ties break on the ID.
"created_at""updated_at""name""bytes"order?stringSort order. Defaults to desc.
"asc""desc"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
The page of matching snapshots
application/json- response
A page of matching snapshots.
next_cursor?|Continuation token for the next page; null on the last page.
snapshots*array<>Matching snapshots in this page.
total*integerThe number of matching snapshots. Exact when total_relation is
eq, and a lower bound of 10000 when it is gte.
int640 <= valuetotal_relation*SearchTotalRelationWhether total is exact (eq) or a lower bound (gte).
"eq""gte"curl -X GET 'https://example.com/snapshots/search'{ "next_cursor": "string", "snapshots": [ { "bytes": 0, "class": "linux", "created_at": "2019-08-24T14:15:22Z", "error": "string", "id": "string", "kind": "full", "memory_bytes": 0, "name": "string", "region_id": "string", "region_ids": [ "string" ], "sandbox_id": "string", "status": "string", "updated_at": "2019-08-24T14:15:22Z", "cursor": "string" } ], "total": 0, "total_relation": "eq"}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
bytes?|The disk size in bytes, or null until capture completes.
int64class*"linux"The sandbox class.
"linux"created_at*stringWhen the snapshot was created.
date-timeerror?|The failure detail, or null when capture has not failed.
id*stringThe snapshot ID.
kind*"full"The snapshot kind. A full snapshot captures memory and disk.
"full"memory_bytes?|The memory size in bytes, or null for snapshots without memory state.
int64name*stringThe project-unique snapshot name.
region_id*stringThe home region.
region_ids*array<string>Every region where the snapshot is available.
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'{ "bytes": 0, "class": "linux", "created_at": "2019-08-24T14:15:22Z", "error": "string", "id": "string", "kind": "full", "memory_bytes": 0, "name": "string", "region_id": "string", "region_ids": [ "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'