Skip to main content
GET
Read a snapshot

Authorizations

Authorization
string
header
required

A team API key, sk_offstage_…, created in the console. Everything it touches belongs to its team.

Path Parameters

snapshotId
string
required

Response

Snapshot details.

id
string
required
sourceSandboxId
string
required
session
enum<string>
required

headless: the slot's user with no desktop; every slot takes it from boot. gui: the slot's logged-in desktop session, remade after every customer, so gui slots are scarce.

Available options:
headless,
gui
createdAt
integer
required
Required range: x >= 0
expiresAt
integer
required
Required range: x >= 0
bytes
integer
required
Required range: x >= 0
state
enum<string>
required
Available options:
capturing,
failed,
local,
unavailable,
durable
name
string
durableAt
integer
Required range: x >= 0
error
string