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

Name	Type	Description
wid	string	Workspace ID

Query parameters

Name	Type	Description
id	string[]	Filter to specific snapshot IDs
instance	string[]	Filter by source instance ID
disk	string[]	Filter by source disk ID
owner	string[]	Filter by workspace ID
state	string[]	Filter by resource state (PENDING, AVAILABLE, FAILED, SUSPENDED, DELETING, UNPLACED)

All filters are optional. Plus the shared pagination parameters. Returns 200 OK with a KeysetResultSnapshotListView containing snapshot list items and pagination fields: limit, page, total, has_next, has_previous, after, and before.

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

Fetch a snapshot

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

Path parameters

Name	Type	Description
sid	string	Snapshot ID

Returns 200 OK with a SnapshotListView containing id, created, disk, instance, owner, and state. The disk, instance, and owner are references with id and name.

Delete a snapshot

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

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

Path parameters

Name	Type	Description
sid	string	Snapshot ID

Returns 202 Accepted with a WorkflowData object. 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:

• Create a snapshot
• Restore a snapshot