Volumes
A volume is where you store your data inside your Instance. It appears as a block device on Linux that you can use to create a filesystem and mount it.
The Instance API only supports l_ssd and scratch volume types.
Block storage volumes can also be attached to Instances, these volumes are
managed by the SBS API (https://www.scaleway.com/en/developers/api/block/Open in new context).
Minimum and maximum volume sizes for each volume type can be queried
from the zone /volume-types API endpoint.
Each type of volume is also subject to a global quota for the sum of all the volumes. This quota depends on the level of support and may be changed on demand.
When using multiple block devices, it's advised to mount them by
using their UUID instead of their device name. A device name is
subject to change depending on the volumes order. Block devices
UUIDs can be found in /dev/disk/by-id/.
List volumes
path Parameters
zoneThe zone you want to target
query Parameters
project_idFilter by Project ID.
page_tokenToken for pagination.
page_sizeNumber of items to return per page.
order_byField to order the results by.
volume_idsFilter by specific volume IDs.
nameFilter by volume name.
tagsFilter by tags.
volume_typeFilter by volume type.
List volumes › Responses
List of volumes.
next_page_tokenToken for the next page.
total_countTotal number of items.
Create a volume
Create a volume of a specified type.
path Parameters
zoneThe zone you want to target
Create a volume › Request Body
project_idProject ID to which the volume belongs.
nameVolume name.
tagsTags associated with the volume.
sizeVolume size in bytes. (in bytes)
base_snapshot_idID of the base snapshot used for this volume.
volume_typeType of the volume.
Create a volume › Responses
idUnique ID of the volume.
project_idProject ID to which the volume belongs.
nameVolume name.
tagsTags associated with the volume.
sizeVolume size in bytes. (in bytes)
base_snapshot_idID of the base snapshot used for this volume.
statusCurrent status of the volume.
volume_typeType of the volume.
created_atCreation date of the volume. (RFC 3339 format)
updated_atLast update date of the volume. (RFC 3339 format)
server_idID of the Instance to which the volume is attached.
zoneZone in which the volume is located.
Get a volume
Get a specified volume.
path Parameters
zoneThe zone you want to target
volume_idID of the volume to retrieve.
Get a volume › Responses
idUnique ID of the volume.
project_idProject ID to which the volume belongs.
nameVolume name.
tagsTags associated with the volume.
sizeVolume size in bytes. (in bytes)
base_snapshot_idID of the base snapshot used for this volume.
statusCurrent status of the volume.
volume_typeType of the volume.
created_atCreation date of the volume. (RFC 3339 format)
updated_atLast update date of the volume. (RFC 3339 format)
server_idID of the Instance to which the volume is attached.
zoneZone in which the volume is located.
Update a volume
Update the properties of a specified volume.
path Parameters
zoneThe zone you want to target
volume_idID of the volume to update.
Update a volume › Request Body
nameNew name for the volume.
tagsNew tags for the volume.
sizeNew size for the volume. (in bytes)
Update a volume › Responses
idUnique ID of the volume.
project_idProject ID to which the volume belongs.
nameVolume name.
tagsTags associated with the volume.
sizeVolume size in bytes. (in bytes)
base_snapshot_idID of the base snapshot used for this volume.
statusCurrent status of the volume.
volume_typeType of the volume.
created_atCreation date of the volume. (RFC 3339 format)
updated_atLast update date of the volume. (RFC 3339 format)
server_idID of the Instance to which the volume is attached.
zoneZone in which the volume is located.