v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB

Volumes

List volumes

Retrieve a list of volumes in the project and region. The list can be filtered by various parameters like bootable status, metadata/tags, attachments, instance ID, name, and ID.

get/cloud/v1/volumes/{project_id}/{region_id}

Path parameters

project_idinteger required

Project ID

Example:1

Project ID

region_idinteger required

Region ID

Example:1

Region ID

Query parameters

bootableboolean

Filter by bootable field

cluster_idstring

Filter volumes by k8s cluster ID

Example:t12345

Filter volumes by k8s cluster ID

has_attachmentsboolean

Filter by the presence of attachments

Example:true

Filter by the presence of attachments

id_partstring

Filter the volume list result by the ID part of the volume

Example:726ecfcc-7fd0-4e30-a86e-7892524aa483

Filter the volume list result by the ID part of the volume

instance_idstring uuid4

Filter volumes by instance ID

Example:169942e0-9b53-42df-95ef-1a8b6525c2bd

Filter volumes by instance ID

limitinteger

Optional. Limit the number of returned items

Example:1000

Optional. Limit the number of returned items

name_partstring

Filter volumes by name_part inclusion in volume name.Any substring can be used and volumes will be returned with names containing the substring.

Example:test

Filter volumes by name_part inclusion in volume name.Any substring can be used and volumes will be returned with names containing the substring.

offsetinteger

Optional. Offset value is used to exclude the first set of records from the result

tag_keystring[]

Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

[
  "key1",
  "key2"
]

tag_key_valuestring

Optional. Filter by tag key-value pairs.

Response

countinteger required

Number of objects

Example response

{
  "count": 1,
  "results": [
    {
      "attachments": [
        {
          "attached_at": "2019-07-26T14:22:03+0000",
          "attachment_id": "f2ed59d9-8068-400c-be4b-c4501ef6f33c",
          "device": "/dev/vda",
          "flavor_id": "g1-standard-1-2",
          "instance_name": "instance-1",
          "server_id": "8dc30d49-bb34-4920-9bbd-03a2587ec0ad",
          "volume_id": "67baa7d1-08ea-4fc5-bef2-6b2465b7d227"
        }
      ],
      "created_at": "2019-05-29T05:32:41+0000",
      "creator_task_id": "d74c2bb9-cea7-4b23-a009-2f13518ae66d",
      "id": "726ecfcc-7fd0-4e30-a86e-7892524aa483",
      "limiter_stats": {
        "MBps_base_limit": 50,
        "MBps_burst_limit": 200,
        "iops_base_limit": 1000,
        "iops_burst_limit": 5000
      },
      "name": "volume-1",
      "project_id": 1,
      "region": "Luxembourg",
      "region_id": 1,
      "size": 50,
      "tags": [
        {
          "key": "my-tag",
          "read_only": false,
          "value": "my-tag-value"
        }
      ],
      "updated_at": "2019-05-29T05:39:20+0000",
      "volume_image_metadata": {
        "checksum": "ba3cd24377dde5dfdd58728894004abb",
        "container_format": "bare",
        "disk_format": "raw",
        "image_id": "723037e2-ec6d-47eb-92de-6276c8907839",
        "image_name": "cirros-gcloud",
        "min_disk": "1",
        "min_ram": "0",
        "size": "46137344"
      },
      "volume_type": "standard"
    }
  ]
}