Skip to main content
POST
Create snapshot

Authorizations

Authorization
string
header
required

OAuth2 authentication with JWT tokens

Body

application/json

Request body for creating a snapshot. The source object is required at the root endpoint and implied by the path on the nested one.

name
string

Display name of the snapshot, unique among the snapshots of the sandbox it is captured from; the same name may be reused on another sandbox. Defaults to the snapshot identifier when absent.

Example:

"my-snapshot"

source
object

The object a snapshot was captured from.

Response

Snapshot created successfully

A point-in-time snapshot of a sandbox. It is a workspace-level object: it outlives the sandbox it was captured from, and can be restored onto a sandbox or forked into a new sandbox or application on its own.

createdAt
string
required

When the snapshot was created

id
string
required
read-only

Identifier of the snapshot, unique in the workspace. Workspace-level routes address the snapshot by it.

Example:

"snap_abc123"

name
string
required

Display name of the snapshot, unique among the snapshots of the sandbox it was captured from. Defaults to the identifier.

Example:

"my-snapshot"

status
string
required

Status of the snapshot (pending, ready, failed)

Example:

"ready"

workspace
string
required

Workspace owning the snapshot

createdBy
string

Who created the snapshot

sandboxName
string

Name of the source sandbox. Kept for compatibility, read source.name instead.

source
object

The object a snapshot was captured from.

spec
object

The configuration a snapshot carries, so a sandbox or an application can be created from it once its source object is gone.

Last modified on September 11, 2026