Disks

A disk is a block volume. Every instance has at least one boot disk. Disk responses include a top-level nullable usage_pct field when live usage data is available. Attaching and detaching a disk are asynchronous.

Search workspace disks

GET/v1/workspaces/{wid}/disksSearch workspace disks

Lists disks belonging to a workspace, with pagination.

Path parameters

Name	Type	Description
wid	string	Workspace ID, required

Query parameters

Name	Type	Description
q	string	Quick search by name or ID
id	string[]	Filter to specific disk IDs
instance	string[]	Filter by attached instance ID
owner	string[]	Filter by workspace ID
name	string	Filter by name
boot	boolean	Filter to boot disks only, or non-boot disks only
state	string[]	Filter by resource state: PENDING, AVAILABLE, FAILED, SUSPENDED, DELETING, or UNPLACED
backend	string[]	Filter by storage backend (LOCAL, CEPH)

All query parameters are optional. Plus the shared pagination parameters. Returns 200 OK with KeysetResultEnrichedDiskListViewDiskLive, containing items, has_next, has_previous, limit, page, total, and nullable after and before cursors.

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

Fetch a disk

GET/v1/disks/{did}Fetch disk by ID

Path parameters

Name	Type	Description
did	string	Disk ID, required

Returns 200 OK with EnrichedDiskDetailViewDiskLive, including backend, boot, size in bytes, attached instance, state, nullable region, and top-level nullable usage_pct.

Update a disk

PATCH/v1/disks/{did}Update disk settings

Updates disk settings. The request body is required. All body fields are optional.

Path parameters

Name	Type	Description
did	string	Disk ID, required

Request body

Field	Type	Description
name	string	Rename the disk, 4 to 32 characters

Returns 200 OK with the updated EnrichedDiskDetailViewDiskLive.

Attach a disk

POST/v1/disks/{did}/attachAttach a disk to an instance

Attaches the disk to an instance. The disk must be detached and AVAILABLE.

Path parameters

Name	Type	Description
did	string	Disk ID, required

Request body

Field	Type	Required	Description
instance_id	string	yes	Instance to attach the disk to

Returns workflow data (200 OK).

Detach a disk

POST/v1/disks/{did}/detachDetach a disk from its instance

Detaches the disk from its current instance. The disk must be attached.

Path parameters

Name	Type	Description
did	string	Disk ID, required

No request body. Returns workflow data (200 OK).