Skip to main content
GET
Get a snapshot

Authorizations

X-API-Key
string
header
required

Path Parameters

snapshot_id
string<uuid>
required

The unique identifier of the snapshot.

Response

The snapshot

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