A snapshot is a consistent, instantaneous copy of the Block Storage volume of your Database Instance at a certain point in time. They are designed to recover your data in case of failure or accidental alterations of the data by a user. They allow you to quickly create a new Instance from a previous state of your database, regardless of the size of the volume. Their limitation is that, unlike backups, snapshots can only be stored in the same location as the original data.
Create a Database Instance snapshot
Create a new snapshot of a Database Instance. You must define the name parameter in the request.
path Parameters
regionThe region you want to target
instance_idUUID of the Database Instance.
Create a Database Instance snapshot › Request Body
nameName of the snapshot.
expires_atExpiration date (must follow the ISO 8601 format). (RFC 3339 format)
Create a Database Instance snapshot › Responses
idUUID of the snapshot.
instance_idUUID of the Database Instance.
nameName of the snapshot.
statusStatus of the snapshot.
sizeSize of the snapshot. (in bytes)
expires_atExpiration date (must follow the ISO 8601 format). (RFC 3339 format)
created_atCreation date (must follow the ISO 8601 format). (RFC 3339 format)
updated_atUpdated date (must follow the ISO 8601 format). (RFC 3339 format)
instance_nameName of the Database Instance of the snapshot.
node_typeSource node type.
Type of volume where data is stored (lssd, bssd or sbs).
regionRegion of this snapshot.
List snapshots
List snapshots. You can include the instance_id or project_id in your query to get the list of snapshots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
path Parameters
regionThe region you want to target
query Parameters
nameName of the snapshot.
order_byCriteria to use when ordering snapshot listing.
instance_idUUID of the Database Instance.
organization_idOrganization ID the snapshots belongs to.
project_idProject ID the snapshots belongs to.
pagepage_sizeList snapshots › Responses
List of snapshots.
total_countTotal count of snapshots available.
Get a Database Instance snapshot
Retrieve information about a given snapshot, specified by its snapshot_id and region. Full details about the snapshot, like size and expiration date, are returned in the response.
path Parameters
regionThe region you want to target
snapshot_idUUID of the snapshot.
Get a Database Instance snapshot › Responses
idUUID of the snapshot.
instance_idUUID of the Database Instance.
nameName of the snapshot.
statusStatus of the snapshot.
sizeSize of the snapshot. (in bytes)
expires_atExpiration date (must follow the ISO 8601 format). (RFC 3339 format)
created_atCreation date (must follow the ISO 8601 format). (RFC 3339 format)
updated_atUpdated date (must follow the ISO 8601 format). (RFC 3339 format)
instance_nameName of the Database Instance of the snapshot.
node_typeSource node type.
Type of volume where data is stored (lssd, bssd or sbs).
regionRegion of this snapshot.
Delete a Database Instance snapshot
Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the region and snapshot_id parameters of the snapshot you want to delete.
path Parameters
regionThe region you want to target
snapshot_idUUID of the snapshot to delete.
Delete a Database Instance snapshot › Responses
idUUID of the snapshot.
instance_idUUID of the Database Instance.
nameName of the snapshot.
statusStatus of the snapshot.
sizeSize of the snapshot. (in bytes)
expires_atExpiration date (must follow the ISO 8601 format). (RFC 3339 format)
created_atCreation date (must follow the ISO 8601 format). (RFC 3339 format)
updated_atUpdated date (must follow the ISO 8601 format). (RFC 3339 format)
instance_nameName of the Database Instance of the snapshot.
node_typeSource node type.
Type of volume where data is stored (lssd, bssd or sbs).
regionRegion of this snapshot.
Update a Database Instance snapshot
Update the parameters of a snapshot of a Database Instance. You can update the name and expires_at parameters.
path Parameters
regionThe region you want to target
snapshot_idUUID of the snapshot to update.
Update a Database Instance snapshot › Request Body
nameName of the snapshot.
expires_atExpiration date (must follow the ISO 8601 format). (RFC 3339 format)
Update a Database Instance snapshot › Responses
idUUID of the snapshot.
instance_idUUID of the Database Instance.
nameName of the snapshot.
statusStatus of the snapshot.
sizeSize of the snapshot. (in bytes)
expires_atExpiration date (must follow the ISO 8601 format). (RFC 3339 format)
created_atCreation date (must follow the ISO 8601 format). (RFC 3339 format)
updated_atUpdated date (must follow the ISO 8601 format). (RFC 3339 format)
instance_nameName of the Database Instance of the snapshot.
node_typeSource node type.
Type of volume where data is stored (lssd, bssd or sbs).
regionRegion of this snapshot.
Create a new Database Instance from a snapshot
Restore a snapshot. When you restore a snapshot, a new Instance is created and billed to your account. Note that is possible to select a larger node type for your new Database Instance. However, the Block volume size will be the same as the size of the restored snapshot. All Instance settings will be restored if you chose a node type with the same or more memory size than the initial Instance. Settings will be reset to the default if your node type has less memory.
path Parameters
regionThe region you want to target
snapshot_idBlock snapshot of the Database Instance.
Create a new Database Instance from a snapshot › Request Body
instance_nameName of the Database Instance created with the snapshot.
is_ha_clusterDefines whether or not High-Availability is enabled on the new Database Instance.
node_typeThe node type used to restore the snapshot.
Create a new Database Instance from a snapshot › Responses
created_atCreation date (must follow the ISO 8601 format). (RFC 3339 format)
Volumes of the Database Instance.
regionRegion the Database Instance is in.
idUUID of the Database Instance. (UUID format)
nameName of the Database Instance.
organization_idOrganization ID the Database Instance belongs to. (UUID format)
project_idProject ID the Database Instance belongs to. (UUID format)
statusStatus of the Database Instance.
engineDatabase engine of the database (PostgreSQL, MySQL, ...).
Available database engine versions for upgrade.
tagsList of tags applied to the Database Instance.
Advanced settings of the Database Instance.
Backup schedule of the Database Instance.
is_ha_clusterDefines whether or not High-Availability is enabled.
Read Replicas of the Database Instance.
node_typeNode type of the Database Instance.
List of engine settings to be set at database initialization.
List of Database Instance endpoints.
Logs policy of the Database Instance.
backup_same_regionStore logical backups in the same region as the Database Instance.
List of Database Instance maintenance events.
Encryption at rest settings for your Database Instance.
Endpoint of the Database Instance.