Skip to content
Get started

Volumes

List volumes
client.volumes.list(RequestOptionsoptions?): VolumeListResponse { id, created_at, name, 2 more }
get/volumes
Create empty volume
client.volumes.create(VolumeCreateParams { name, size_gb, id } body, RequestOptionsoptions?): Volume { id, created_at, name, 2 more }
post/volumes
Create volume from archive
client.volumes.createFromArchive("string" | "ArrayBuffer" | "ArrayBufferView" | 2 morebody, VolumeCreateFromArchiveParams { name, size_gb, id } params, RequestOptionsoptions?): Volume { id, created_at, name, 2 more }
post/volumes/from-archive
Get volume details
client.volumes.get(stringid, RequestOptionsoptions?): Volume { id, created_at, name, 2 more }
get/volumes/{id}
Delete volume
client.volumes.delete(stringid, RequestOptionsoptions?): void
delete/volumes/{id}
ModelsExpand Collapse
Volume { 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?: Array<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 { 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