Skip to main content
GET
List Snapshots

Authorizations

Authorization
string
header
required

API key from Settings > Developer > REST API

Query Parameters

machine
string | null

Only this machine's (id or name).

Maximum string length: 80
cursor
string | null

next_cursor of the previous page.

Maximum string length: 80

Response

Successful Response

snapshots
MachineSnapshotListItem · object[]
required

Your workspace's snapshots, newest first: never a deleted or expired one.

count
integer
required

Snapshots you asked for that still exist; at limit, taking another is refused.

limit
integer
required

The most snapshots you can ask for that exist at once (automatic ones aside).

next_cursor
string | null
required

Pass as cursor for the next (older) page; null on the last page.

total
integer | null

Snapshots matching this listing across every page, automatic ones included.