v48

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-275867561.6 MB

sandboxes

Capture a snapshot from a sandbox

Create a snapshot by capturing the current state of a sandbox or promoting an existing checkpoint.

post/v2/sandboxes/boxes/{name}/snapshot

Path parameters

namestring required

Sandbox display name

Request body

checkpointstring

if omitted, creates a fresh checkpoint from the running VM

docker_imagestring

sandbox-local Docker image to export

fs_capacity_bytesinteger

required for Docker image export unless the sandbox has a capacity

include_memoryboolean

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.

namestring required

Response

Created

created_atstring

created_bystring

docker_imagestring

fs_capacity_bytesinteger

fs_used_bytesinteger

idstring

image_digeststring

memory_snapshot_size_bytesinteger

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.

namestring

registry_idstring

source_sandbox_idstring

statusstring

status_messagestring

updated_atstring