Skip to content

Volumes

A set of operations for creating and managing volume resources.

The volumes object

The response to volume endpoint API requests includes the instances object, which provides comprehensive details about your volumes.

Attributes

id string

The unique identifier for the volume.

name string

The name of the volume.

display_name string

Display name of the volume.

bootable boolean

Specifies whether the volume is bootable or not, true indicates the volume has an operating system installed.

status string

The current status of the volume (e.g., "available"). All states include creating, available, deleting, downloading, attaching, detaching, in-use.

size_gb int

Size of the volume in GB.

description

Description of the volume.

region string

Region in which the volume is available.

created_time date-time

The timestamp when the volume was created.