A Block Storage volume is a logical storage drive on a network-connected storage system. It is exposed to Instances as if it were a physical disk, and can be attached and detached like a hard drive. Several Block volumes can be attached to one Instance at a time
Block volumes can be snapshotted, mounted or unmounted
List volumes
List all existing volumes in a specified zone. By default, the volumes listed are ordered by creation date in ascending order. This can be modified via the order_by field.
path Parameters
zoneThe zone you want to target
query Parameters
include_deletedDisplay deleted volumes not erased yet.
order_byCriteria to use when ordering the list.
project_idFilter by Project ID.
organization_idFilter by Organization ID.
pagePage number.
page_sizePage size, defines how many entries are returned in one page, must be lower or equal to 100.
nameFilter the return volumes by their names.
product_resource_idFilter by a product resource ID linked to this volume (such as an Instance ID).
tagsFilter by tags. Only volumes with one or more matching tags will be returned.
volume_typeFilter by volume type.
volume_idsFilter by volume IDs.
List volumes › Responses
Paginated returned list of volumes.
total_countTotal number of volumes in the project.
Create a volume
To create a new volume from scratch, you must specify from_empty and the size.
To create a volume from an existing snapshot, specify from_snapshot and the snapshot_id in the request payload instead, size is optional and can be specified if you need to extend the original size. The volume will take on the same volume class and underlying IOPS limitations as the original snapshot.
path Parameters
zoneThe zone you want to target
Create a volume › Request Body
nameName of the volume.
project_idUUID of the project the volume belongs to.
perf_iopsThe maximum IO/s expected, according to the different options available in stock (5000 | 15000).
Specify the size of the new volume if creating a new one from scratch.
Specify the snapshot ID of the original snapshot.
tagsList of tags assigned to the volume.
Create a volume › Responses
idUUID of the volume. (UUID format)
nameName of the volume.
typeVolume type.
sizeVolume size in bytes. (in bytes)
project_idUUID of the project to which the volume belongs. (UUID format)
created_atCreation date of the volume. (RFC 3339 format)
updated_atLast update of the properties of a volume. (RFC 3339 format)
List of the references to the volume.
parent_snapshot_idWhen a volume is created from a snapshot, is the UUID of the snapshot from which the volume has been created. (UUID format)
statusCurrent status of the volume (available, in_use, ...).
tagsList of tags assigned to the volume.
zoneVolume zone.
Specifications of the volume.
last_detached_atLast time the volume was detached. (RFC 3339 format)
Get a volume
Retrieve technical information about a specific volume. Details such as size, type, and status are returned in the response.
path Parameters
zoneThe zone you want to target
volume_idUUID of the volume.
Get a volume › Responses
idUUID of the volume. (UUID format)
nameName of the volume.
typeVolume type.
sizeVolume size in bytes. (in bytes)
project_idUUID of the project to which the volume belongs. (UUID format)
created_atCreation date of the volume. (RFC 3339 format)
updated_atLast update of the properties of a volume. (RFC 3339 format)
List of the references to the volume.
parent_snapshot_idWhen a volume is created from a snapshot, is the UUID of the snapshot from which the volume has been created. (UUID format)
statusCurrent status of the volume (available, in_use, ...).
tagsList of tags assigned to the volume.
zoneVolume zone.
Specifications of the volume.
last_detached_atLast time the volume was detached. (RFC 3339 format)
Delete a detached volume
You must specify the volume_id of the volume you want to delete. The volume must not be in the in_use status.
path Parameters
zoneThe zone you want to target
volume_idUUID of the volume.
Delete a detached volume › Responses
Update a volume
Update the technical details of a volume, such as its name, tags, or its new size and volume_type (within the same Block Storage class).
You can only resize a volume to a larger size. It is currently not possible to change your Block Storage Class.
path Parameters
zoneThe zone you want to target
volume_idUUID of the volume.
Update a volume › Request Body
nameWhen defined, is the new name of the volume.
sizeOptional field for increasing the size of a volume (size must be equal or larger than the current one). Size in bytes of the volume, with a granularity of 1 GB (10^9 bytes). (in bytes)
tagsList of tags assigned to the volume.
perf_iopsThe maximum IO/s expected, according to the different options available in stock (5000 | 15000).
The selected value must be available for the volume's current storage class.
Update a volume › Responses
idUUID of the volume. (UUID format)
nameName of the volume.
typeVolume type.
sizeVolume size in bytes. (in bytes)
project_idUUID of the project to which the volume belongs. (UUID format)
created_atCreation date of the volume. (RFC 3339 format)
updated_atLast update of the properties of a volume. (RFC 3339 format)
List of the references to the volume.
parent_snapshot_idWhen a volume is created from a snapshot, is the UUID of the snapshot from which the volume has been created. (UUID format)
statusCurrent status of the volume (available, in_use, ...).
tagsList of tags assigned to the volume.
zoneVolume zone.
Specifications of the volume.
last_detached_atLast time the volume was detached. (RFC 3339 format)