Skip to main content
GET
Error

Authorizations

X-API-Key
string
header
required

Path Parameters

snapshot_id
string
required

Snapshot UUID, a name:tag reference, or a bare snapshot name

Response

OK

created_at
string
created_by
string
description
string

Description says what this snapshot's image can do, so a caller can hand it to an agent as a capability summary.

docker_image
string
fs_capacity_bytes
integer
fs_used_bytes
integer
id
string
image_digest
string
included
enum<string>[]

The settings this snapshot carries, in include terms: sandboxes created from it start with each one their create request leaves unset. Env var values are never returned.

Available options:
mounts,
proxy_config,
env_vars,
resources,
lifecycle,
labels
labels
object
memory_snapshot_size_bytes
integer

MemorySnapshotSizeBytes is non-nil iff the snapshot was captured with VM memory state. A non-nil value is the canonical signal that this snapshot can warm-restore from memory; nil means rootfs only.

mount_config
object

The mount_config sandboxes created from this snapshot start with when their create request has none, with secret values redacted. Present only on snapshots captured with include "mounts" or "all" from a sandbox that had mounts.

name
string
proxy_config
object

The proxy_config sandboxes created from this snapshot start with when their create request has none, with secret values redacted. Present only on snapshots captured with include "proxy_config" or "all".

registry_id
string
run_config
object

RunConfig is what sandboxes from this snapshot boot with. Absent on snapshots built before it was recorded, which run as root with their own env.

source_sandbox_id
string
status
string
status_message
string
tags
string[]

Tags currently resolving to this snapshot, under Name. A snapshot with no tags is dangling — addressable only by id.

updated_at
string