v12

latestOpenAPI 3.0.3raw.githubusercontent.com2026-06-1811583196.1 KB
Volumes

List volumes

List volumes for the authenticated account. Filter by VM or region.

Pass X-Project-ID to scope the list to a single project. When omitted, returns volumes across every project the API key has access to.

get/api/v1/volumes

Query parameters

vm_idstring uuid

Filter by attached VM UUID

region'us-east'

Filter by region

limitinteger
offsetinteger

Headers

X-Project-IDstring uuid

Optional project ID to scope the list. Omit to list across all accessible projects.

Response

List of volumes

successboolean
totalinteger

Example response

{
  "data": [
    {
      "name": "data-vol-1",
      "volume_type": "nvme",
      "size": 100
    }
  ]
}