Skip to content

Snapshots

A snapshot is a point-in-time copy of a disk. These endpoints let you search, inspect, and delete snapshots. Creating a snapshot and restoring one are performed through instance command endpoints; see Instance commands.

Search workspace snapshots

GET/v1/workspaces/{wid}/snapshotsSearch workspace snapshots

Lists snapshots belonging to a workspace, with pagination.

Path parameters

NameTypeDescription
widintegerWorkspace ID

Query parameters

NameTypeDescription
idinteger[]Filter to specific snapshot IDs
instanceinteger[]Filter by source instance ID
diskinteger[]Filter by source disk ID
ownerinteger[]Filter by workspace ID
statestring[]Filter by resource state (AVAILABLE, PENDING, ...)

Plus the shared pagination parameters. Returns a paged list of snapshots.

bash
curl https://api.galaxygate.net/v1/workspaces/42/snapshots \
  -H "Authorization: Bearer $GALAXYGATE_TOKEN" \
  -A 'curl/8.5'

Search all snapshots

GET/v1/snapshotsSearch all snapshots

Administrator-only catalog view. Accepts the same query parameters as the workspace-scoped endpoint above and returns snapshots across all workspaces. Returns a paged list of snapshots.

Fetch a snapshot

GET/v1/snapshots/{id}Fetch snapshot by ID

Path parameters

NameTypeDescription
idintegerSnapshot ID

Returns the full snapshot detail, including the source disk, source instance, size, and state.

Delete a snapshot

DELETE/v1/snapshots/{id}Delete a snapshot

Deletes a snapshot and frees its storage. This is asynchronous.

Path parameters

NameTypeDescription
idintegerSnapshot ID

Returns a workflow (202 Accepted). Poll GET /v1/workflows/{wfid} or watch the snapshot until it disappears.

Creating and restoring snapshots

Creating a snapshot and restoring a snapshot onto an instance disk are instance command operations: