API Reference

Compute

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Volumes

Create Volume

POST/v1/compute/volumes

Get Volume

GET/v1/compute/volumes/{volume_id}

Update Volume

PATCH/v1/compute/volumes/{volume_id}

Delete Volume

DELETE/v1/compute/volumes/{volume_id}

List Volumes

GET/v1/compute/volumes

Attach Volume

POST/v1/compute/volumes/{volume_id}/attach

Detach Volume

POST/v1/compute/volumes/{volume_id}/detach

ModelsExpand Collapse

Volume object { id, created_at, kind, 10 more }

Volume details.

id: string

Unique identifier for the Volume.

created_at: string

When the Volume was created.

formatdate-time

kind: VolumeKind

Volume kind.

One of the following:

"boot"

"data"

name: string

Name of the Volume.

project_id: string

Project ID the Volume belongs to.

region: RegionName

Region the resource is in.

size: number

Size of the Volume in GB.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

tags: array of string

Tags to attach to the Volume.

type: VolumeType

Type of the Volume.

One of the following:

"nvme"

"abs"

updated_at: string

When the Volume was updated.

formatdate-time

vm_id: string

ID of the VM the Volume is attached to.

vm_name: string

Name of the VM the Volume is attached to.

VolumeKind = "boot" or "data"

Volume kind.

One of the following:

"boot"

"data"

VolumeList object { items, pagination }

items: array of Volume { id, created_at, kind, 10 more }

id: string

Unique identifier for the Volume.

created_at: string

When the Volume was created.

formatdate-time

kind: VolumeKind

Volume kind.

One of the following:

"boot"

"data"

name: string

Name of the Volume.

project_id: string

Project ID the Volume belongs to.

region: RegionName

Region the resource is in.

size: number

Size of the Volume in GB.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

tags: array of string

Tags to attach to the Volume.

type: VolumeType

Type of the Volume.

One of the following:

"nvme"

"abs"

updated_at: string

When the Volume was updated.

formatdate-time

vm_id: string

ID of the VM the Volume is attached to.

vm_name: string

Name of the VM the Volume is attached to.

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

minimum0

VolumeType = "nvme" or "abs"

Type of the Volume.

One of the following:

"nvme"

"abs"

VolumesAvailability

Check Volume Create Availability

POST/v1/compute/volumes/availability

Check Volume Update Availability

PATCH/v1/compute/volumes/{volume_id}/availability