Capture a snapshot from a sandbox
Create a snapshot by capturing the current state of a sandbox or promoting an existing checkpoint.
Authorizations
Path Parameters
Sandbox display name
Body
if omitted, creates a fresh checkpoint from the running VM
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.
1024sandbox-local Docker image to export
required for Docker image export unless the sandbox has a capacity
IncludeMemory, when true, captures a full VM memory snapshot alongside the filesystem clone. Only honored when the sandbox is running AND Checkpoint is omitted (i.e. a fresh in-VM checkpoint is requested). Defaults to false to keep snapshots small unless memory restore is explicitly desired.
Labels seed the captured snapshot's labels.
RunConfig overrides the runtime configuration the snapshot carries: for a docker_image export, the image's USER, WORKDIR and ENV; for a capture of the running VM, the sandbox's own. user and work_dir replace, env_vars merge.
mutable Docker-style tag; defaults to "latest"
Response
Created
Description says what this snapshot's image can do, so a caller can hand it to an agent as a capability summary.
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.
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.
Tags currently resolving to this snapshot, under Name. A snapshot with no tags is dangling — addressable only by id.

