Skip to main content
POST
Snapshot a sandbox
Create a snapshot of a running sandbox so you can restore the same filesystem and memory state later. You can optionally pass snapshot_type in the request body:
  • filesystem (default): captures filesystem state only and restores with a cold boot.
  • memory: captures filesystem, memory, and running process state and restores with a warm start.

Endpoint

Example Request

Use the created snapshot with Restore Sandbox when you want to boot a new sandbox from that saved state. For the broader snapshot lifecycle, including listing and deleting snapshots, see Snapshots.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

sandbox_id
string
required

The ID of the sandbox.

Body

application/json
snapshot_type
enum<string>

Snapshot type. memory captures filesystem, memory, and running process state for warm restore. filesystem captures filesystem state only for cold-boot restore. When omitted, the server default is filesystem.

Available options:
memory,
filesystem

Response

Snapshot creation initiated

snapshot_id
string
required
status
string
required