Skip to main content

Volumes

statusboolean

Whether the request succeeded.

Example: true
messagestring

Human-readable description of the result.

Example: Getting volumes successful
pageintegernullable

1-indexed page number of the current result set.

page_sizeintegernullable

Number of items per page in the current result set.

countinteger

Number of items returned in the current page.

Example: 5
volumes object[]

Volumes returned by the request.

  • Array [
    • idinteger

    Unique numeric identifier for the volume.

    Example: 9876
    namestring

    Name of the volume.

    Example: example-volume
    environment object

    Environment the volume belongs to.

    namestring

    Name of the environment.

    Example: example-environment
    features object

    Feature flags enabled in the environment.

    object
    regionstring

    Region the environment is in: CANADA-1, NORWAY-1, or US-1.

    Example: NORWAY-1
    descriptionstring

    Description of the volume.

    Example: example
    volume_typestring

    Storage tier of the volume.

    Example: Cloud-SSD
    sizeinteger

    Volume capacity in GB.

    Example: 10
    statusstring

    Current status of the volume.

    Example: available
    bootableboolean

    Whether the volume is a bootable volume.

    Example: false
    image_idintegernullable

    Identifier of the operating system image the volume was created from, or null if none.

    callback_urlstringnullable

    Webhook URL called with notifications about this volume, or null if none is set.

    created_atstring<date-time>

    ISO 8601 UTC timestamp marking when the volume was created.

    Example: 2026-05-07T09:21:55Z
    updated_atstring<date-time>nullable

    ISO 8601 UTC timestamp marking when the volume was last updated.

    Example: 2026-05-07T09:21:55Z
    attachments object[]

    Virtual machines the volume is attached to.

  • Array [
    • idinteger

    Unique numeric identifier for the volume attachment.

    Example: 2058
    devicestring

    Device path the volume is attached at on the VM.

    Example: /dev/disk/by-id/virtio-05ff4fce-957f-486c-b
    statusstring

    Status of the volume attachment.

    Example: ATTACHING
    instance_idinteger

    Identifier of the virtual machine the volume is attached to.

    Example: 1402
    protectedboolean

    When true, the volume attachment is protected from deletion.

    Example: false
  • ]
  • ]
    • Volumes
    {
      "status": true,
      "message": "Getting volumes successful",
      "page": 0,
      "page_size": 0,
      "count": 5,
      "volumes": [
        {
          "id": 9876,
          "name": "example-volume",
          "environment": {
            "name": "example-environment",
            "features": {},
            "region": "NORWAY-1"
          },
          "description": "example",
          "volume_type": "Cloud-SSD",
          "size": 10,
          "status": "available",
          "bootable": false,
          "image_id": 0,
          "callback_url": "string",
          "created_at": "2026-05-07T09:21:55Z",
          "updated_at": "2026-05-07T09:21:55Z",
          "attachments": [
            {
              "id": 2058,
              "device": "/dev/disk/by-id/virtio-05ff4fce-957f-486c-b",
              "status": "ATTACHING",
              "instance_id": 1402,
              "protected": false
            }
          ]
        }
      ]
    }