| Name | Type | Description |
|---|---|---|
checkpoint | str | Omit | Default: omitif omitted, creates a fresh checkpoint from the running VM |
description | str | Omit | Default: omitDescription 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. |
docker_image | str | Omit | Default: omit |
fs_capacity_bytes | int | Omit | Default: omit |
include_memory | bool | Omit | Default: omit |
labels | Dict[str, str] | Omit | Default: omit |
run_config | box_create_snapshot_params.RunConfig | Omit | Default: omit |
tag | str | Omit | Default: omit |
extra_headers | Headers | None | Default: None |
extra_query | Query | None | Default: None |
extra_body | Body | None | Default: None |
timeout | float | httpx.Timeout | None | NotGiven | Default: not_given |
Create a snapshot by capturing the current state of a sandbox or promoting an existing checkpoint.
sandbox-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"
Send extra headers
Add additional query parameters to the request
Add additional JSON properties to the request
Override the client-level default timeout for this request, in seconds
