List Volumes

$ nirvana compute:volumes list

GET/v1/compute/volumes

List all volumes

ParametersExpand Collapse

--project-id: string

Project ID of resources to request

--cursor: optional string

Pagination cursor returned by a previous request

--limit: optional number

Maximum number of items to return

ReturnsExpand Collapse

volume_list: 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.

kind: "boot" or "data"

Volume kind.

"boot"

"data"

name: string

Name of the Volume.

project_id: string

Project ID the Volume belongs to.

region: "us-sva-2"

Region the resource is in.

"us-sva-2"

size: number

Size of the Volume in GB.

status: "pending" or "creating" or "updating" or 4 more

Status of the resource.

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

tags: array of string

Tags to attach to the Volume.

type: "nvme" or "abs"

Type of the Volume.

"nvme"

"abs"

updated_at: string

When the Volume was updated.

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: object { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

List Volumes

nirvana compute:volumes list \
  --api-key 'My API Key' \
  --project-id project_id

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-01-01T00:00:00Z",
      "kind": "boot",
      "name": "my-volume",
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "region": "us-sva-2",
      "size": 100,
      "status": "ready",
      "tags": [
        "production",
        "ethereum"
      ],
      "type": "abs",
      "updated_at": "2025-01-01T00:00:00Z",
      "vm_id": "123e4567-e89b-12d3-a456-426614174000",
      "vm_name": "my-vm"
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}

Returns Examples

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-01-01T00:00:00Z",
      "kind": "boot",
      "name": "my-volume",
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "region": "us-sva-2",
      "size": 100,
      "status": "ready",
      "tags": [
        "production",
        "ethereum"
      ],
      "type": "abs",
      "updated_at": "2025-01-01T00:00:00Z",
      "vm_id": "123e4567-e89b-12d3-a456-426614174000",
      "vm_name": "my-vm"
    }
  ],
  "pagination": {
    "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
    "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
    "total_count": 125
  }
}