Sign in
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

Changes

Changed in 2 of the 48 revisions of this API.10

  • a0acb3a6a1019See the full diff
    • ○

      added the new optional request property docker_image

      new-optional-request-property

    • ○

      added the new optional request property fs_capacity_bytes

      new-optional-request-property

    • ○

      added the new optional request property include_memory

      new-optional-request-property

    • ○

      added the optional property detail/error_id to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property detail/error_id to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property detail/error_id to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property detail/error_id to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property detail/error_id to the response with the 500 status

      response-optional-property-added

    • ○

      added the optional property memory_snapshot_size_bytes to the response with the 201 status

      response-optional-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e86be67718ee1See the full diff
    • ○

      endpoint added

      endpoint-added