Skip to main content
POST
Error

Authorizations

X-API-Key
string
header
required

Body

application/json
docker_image
string
required
fs_capacity_bytes
integer
required
name
string
required
description
string

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

Maximum string length: 1024
labels
object

Labels seed the snapshot's labels, overriding any label of the same key derived from the Docker image.

registry_id
string
run_config
object

RunConfig overrides the runtime configuration taken from the Docker image. Every sandbox created from the snapshot runs as the image's USER, in its WORKDIR, with its ENV beneath the sandbox's own env_vars; user and work_dir given here replace the image's, and env_vars merge over it.

tag
string

mutable Docker-style tag; defaults to "latest"

Response

Created

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
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.

name
string
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