Skip to main content

Update_Volume_Response

statusboolean

Whether the request succeeded.

messagestring

Human-readable description of the result.

Example: Input payload validation failed
volume object

Volume attached to the resource.

idinteger

Unique numeric identifier for the volume.

Example: 7613
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: creating
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-06T15:18:42Z
updated_atstring<date-time>nullable

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

Example: 2026-05-06T15:18:42Z
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
  • ]
    • os_imagestring

    Name of the operating system image the volume was created from.

    Example:
    updates object

    Summary of fields that were updated

    object
    Update_Volume_Response
    {
      "status": true,
      "message": "Input payload validation failed",
      "volume": {
        "id": 7613,
        "name": "example-volume",
        "environment": {
          "name": "example-environment",
          "features": {},
          "region": "NORWAY-1"
        },
        "description": "example",
        "volume_type": "Cloud-SSD",
        "size": 10,
        "status": "creating",
        "bootable": false,
        "image_id": 0,
        "callback_url": "string",
        "created_at": "2026-05-06T15:18:42Z",
        "updated_at": "2026-05-06T15:18:42Z",
        "attachments": [
          {
            "id": 2058,
            "device": "/dev/disk/by-id/virtio-05ff4fce-957f-486c-b",
            "status": "ATTACHING",
            "instance_id": 1402,
            "protected": false
          }
        ],
        "os_image": ""
      },
      "updates": {}
    }