Skip to main content
GET
Get snapshot

Authorizations

Authorization
string
header
required

OAuth2 authentication with JWT tokens

Path Parameters

snapshotName
string
required

ID of the snapshot

Response

successful operation

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