Sign in
Snapshots

`POST /v1/sandboxes/{id}/snapshots`

Initiates a snapshot of the sandbox. The response is 202 Accepted with the snapshot row in creating status. The caller should poll GET /v1/sandbox-snapshots/{snap_id} until status is ready or failed.

The sandbox is stopped for the duration of the snapshot and restarted automatically when it completes (unless it was already stopped).

post/v1/sandboxes/{id}/snapshots

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/sandboxes/{id}/snapshots
  • Auth: HTTP bearer

Path parameters

idstring required

Sandbox public ID

Request body

labelstring nullable

Optional human-readable label for the snapshot.

Response

Snapshot initiated

backendstring required
content_digeststring required
created_atstring required
idstring required
image_refstring nullable
labelstring nullable
project_idinteger nullable
size_bytesinteger required
statusstring required
updated_atstring required

Changes

No recorded changes to this operation across all 50 revisions of this API.