A Block Storage snapshot is a read-only picture of a Block volume, taken at a specific time You can then revert your data to the previous snapshot. You can also create a new read/write Block volume from a previous snapshot
List all snapshots
List all available snapshots in a specified zone. By default, the snapshots 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 snapshots 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.
volume_idFilter snapshots by the ID of the original volume.
nameFilter snapshots by their names.
tagsFilter by tags. Only snapshots with one or more matching tags will be returned.
List all snapshots › Responses
Paginated returned list of snapshots.
total_countTotal number of snapshots in the project.
Create a snapshot of a volume
To create a snapshot, the volume must be in the in_use or the available status.
If your volume is in a transient state, you need to wait until the end of the current operation.
path Parameters
zoneThe zone you want to target
Create a snapshot of a volume › Request Body
volume_idUUID of the volume to snapshot.
nameName of the snapshot.
project_idUUID of the project to which the volume and the snapshot belong.
tagsList of tags assigned to the snapshot.
publicPublic snapshots can be used by anyone to create a volume from. Snapshots are private by default, public snapshots are mainly used to publish OS images.
Create a snapshot of a volume › Responses
idUUID of the snapshot. (UUID format)
nameName of the snapshot.
Information about the parent volume. If the parent volume was deleted, value is null.
sizeSize in bytes of the snapshot. (in bytes)
project_idUUID of the project the snapshot belongs to. (UUID format)
created_atCreation date of the snapshot. (RFC 3339 format)
updated_atLast modification date of the properties of a snapshot. (RFC 3339 format)
List of the references to the snapshot.
statusCurrent status of the snapshot (available, in_use, ...).
tagsList of tags assigned to the volume.
zoneSnapshot zone.
classStorage class of the snapshot.
publicTrue if the snapshot can be used by anyone to create a volume from.
Get a snapshot
Retrieve technical information about a specific snapshot. Details such as size, volume type, and status are returned in the response.
path Parameters
zoneThe zone you want to target
snapshot_idUUID of the snapshot.
Get a snapshot › Responses
idUUID of the snapshot. (UUID format)
nameName of the snapshot.
Information about the parent volume. If the parent volume was deleted, value is null.
sizeSize in bytes of the snapshot. (in bytes)
project_idUUID of the project the snapshot belongs to. (UUID format)
created_atCreation date of the snapshot. (RFC 3339 format)
updated_atLast modification date of the properties of a snapshot. (RFC 3339 format)
List of the references to the snapshot.
statusCurrent status of the snapshot (available, in_use, ...).
tagsList of tags assigned to the volume.
zoneSnapshot zone.
classStorage class of the snapshot.
publicTrue if the snapshot can be used by anyone to create a volume from.
Delete a snapshot
You must specify the snapshot_id of the snapshot you want to delete. The snapshot must not be in use.
path Parameters
zoneThe zone you want to target
snapshot_idUUID of the snapshot.
Delete a snapshot › Responses
Update a snapshot
Update the name or tags of the snapshot.
path Parameters
zoneThe zone you want to target
snapshot_idUUID of the snapshot.
Update a snapshot › Request Body
nameWhen defined, is the name of the snapshot.
tagsList of tags assigned to the snapshot.
publicPublic snapshots can be used by anyone to create a volume from. Snapshots are private by default, public snapshots are mainly used to publish OS images.
Update a snapshot › Responses
idUUID of the snapshot. (UUID format)
nameName of the snapshot.
Information about the parent volume. If the parent volume was deleted, value is null.
sizeSize in bytes of the snapshot. (in bytes)
project_idUUID of the project the snapshot belongs to. (UUID format)
created_atCreation date of the snapshot. (RFC 3339 format)
updated_atLast modification date of the properties of a snapshot. (RFC 3339 format)
List of the references to the snapshot.
statusCurrent status of the snapshot (available, in_use, ...).
tagsList of tags assigned to the volume.
zoneSnapshot zone.
classStorage class of the snapshot.
publicTrue if the snapshot can be used by anyone to create a volume from.
Export a snapshot to a Scaleway Object Storage bucket
The snapshot is exported in QCOW2 format. The snapshot must not be in transient state.
path Parameters
zoneThe zone you want to target
snapshot_idUUID of the snapshot. (UUID format)
Export a snapshot to a Scaleway Object Storage bucket › Request Body
bucketScaleway Object Storage bucket where the object is stored.
keyThe object key inside the given bucket.
Export a snapshot to a Scaleway Object Storage bucket › Responses
idUUID of the snapshot. (UUID format)
nameName of the snapshot.
Information about the parent volume. If the parent volume was deleted, value is null.
sizeSize in bytes of the snapshot. (in bytes)
project_idUUID of the project the snapshot belongs to. (UUID format)
created_atCreation date of the snapshot. (RFC 3339 format)
updated_atLast modification date of the properties of a snapshot. (RFC 3339 format)
List of the references to the snapshot.
statusCurrent status of the snapshot (available, in_use, ...).
tagsList of tags assigned to the volume.
zoneSnapshot zone.
classStorage class of the snapshot.
publicTrue if the snapshot can be used by anyone to create a volume from.
Import a snapshot from a Scaleway Object Storage bucket
The bucket must contain a QCOW2 image. The bucket can be imported into any Availability Zone as long as it is in the same region as the bucket.
path Parameters
zoneThe zone you want to target
Import a snapshot from a Scaleway Object Storage bucket › Request Body
bucketScaleway Object Storage bucket where the object is stored.
keyThe object key inside the given bucket.
nameName of the snapshot.
project_idUUID of the Project to which the volume and the snapshot belong.
tagsList of tags assigned to the snapshot.
sizeSize of the snapshot. (in bytes)
Import a snapshot from a Scaleway Object Storage bucket › Responses
idUUID of the snapshot. (UUID format)
nameName of the snapshot.
Information about the parent volume. If the parent volume was deleted, value is null.
sizeSize in bytes of the snapshot. (in bytes)
project_idUUID of the project the snapshot belongs to. (UUID format)
created_atCreation date of the snapshot. (RFC 3339 format)
updated_atLast modification date of the properties of a snapshot. (RFC 3339 format)
List of the references to the snapshot.
statusCurrent status of the snapshot (available, in_use, ...).
tagsList of tags assigned to the volume.
zoneSnapshot zone.
classStorage class of the snapshot.
publicTrue if the snapshot can be used by anyone to create a volume from.