Skip to main content
GET
Get Snapshot

Authorizations

Authorization
string
header
required

API key from Settings > Developer > REST API

Path Parameters

snapshot
string
required

Response

Successful Response

id
string
required

The snapshot id (snp_…): create a machine from it with from_snapshot.

status
string
required

The state (see the enum).

Allowed value: "ready"
name
string | null
required

The name given when it was taken, if any.

machine_id
string
required

The machine it was taken from (mch_…).

machine_name
string | null
required

That machine's name.

size_bytes
integer | null
required

The bytes it stores, when known (null otherwise).

created_at
string | null
required

When it was taken (ISO 8601, UTC).

expires_at
string | null
required

When it expires and is deleted (ISO 8601, UTC); null if never.

automatic
boolean
required

True for a snapshot a pause or automatic stop took; false for one you asked for (only those count toward limit).

in_use_by
string | null
required

The machine (mch_…) that still needs it: a paused machine that resumes from it, or one starting from it. It cannot be deleted until that machine is resumed or released. Null otherwise.

in_use_by_name
string | null
required

That machine's name; null when in_use_by is null.

next
string
required

What to do next, for agents.

note
string | null

The note given when it was taken, if any.