Skip to content
Get started

Volumes

List volumes
get/volumes
Create volume
post/volumes
Get volume details
get/volumes/{id}
Delete volume
delete/volumes/{id}
ModelsExpand Collapse
Volume = object { id, created_at, name, 2 more }
id: string

Unique identifier

created_at: string

Creation timestamp (RFC3339)

formatdate-time
name: string

Volume name

size_gb: number

Size in gigabytes

attachments: optional array of VolumeAttachment { instance_id, mount_path, readonly }

List of current attachments (empty if not attached)

instance_id: string

ID of the instance this volume is attached to

mount_path: string

Mount path in the guest

readonly: boolean

Whether the attachment is read-only

VolumeAttachment = object { instance_id, mount_path, readonly }
instance_id: string

ID of the instance this volume is attached to

mount_path: string

Mount path in the guest

readonly: boolean

Whether the attachment is read-only