Scaleway logo
Managed Database for PostgreSQL and MySQL API
Managed Database for PostgreSQL and MySQL API

Snapshots

Download schema

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

POST
https://api.scaleway.com
/rdb/v1/regions/{region}/instances/{instance_id}/snapshots

Create a new snapshot of a Database Instance. You must define the name parameter in the request.

Create a Database Instance snapshot › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams
pl-waw
instance_id
​string · required

UUID of the Database Instance.

Create a Database Instance snapshot › Request Body

name
​string · required

Name of the snapshot.

expires_at
​string | null · date-time

Expiration date (must follow the ISO 8601 format). (RFC 3339 format)

Create a Database Instance snapshot › Responses

200
scaleway.rdb.v1.Snapshot
id
​string

UUID of the snapshot.

instance_id
​string

UUID of the Database Instance.

name
​string

Name of the snapshot.

status
​scaleway.rdb.v1.Snapshot.Status · enum

Status of the snapshot.

Enum values:
unknown
creating
ready
restoring
deleting
error
locked
Default: unknown
size
​integer | null · uint64

Size of the snapshot. (in bytes)

expires_at
​string | null · date-time

Expiration date (must follow the ISO 8601 format). (RFC 3339 format)

created_at
​string | null · date-time

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

updated_at
​string | null · date-time

Updated date (must follow the ISO 8601 format). (RFC 3339 format)

instance_name
​string

Name of the Database Instance of the snapshot.

node_type
​string

Source node type.

Type of volume where data is stored (lssd, bssd or sbs).

region
​string

Region of this snapshot.

List snapshots

GET
https://api.scaleway.com
/rdb/v1/regions/{region}/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.

List snapshots › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams
pl-waw

List snapshots › query Parameters

name
​string

Name of the snapshot.

order_by
​scaleway.rdb.v1.ListSnapshotsRequest.OrderBy · enum

Criteria to use when ordering snapshot listing.

Enum values:
created_at_asc
created_at_desc
name_asc
name_desc
expires_at_asc
expires_at_desc
Default: created_at_asc
instance_id
​string

UUID of the Database Instance.

organization_id
​string

Organization ID the snapshots belongs to.

project_id
​string

Project ID the snapshots belongs to.

page
​google.protobuf.Int32Value · int32
page_size
​integer · uint32

List snapshots › Responses

200
scaleway.rdb.v1.ListSnapshotsResponse

List of snapshots.

total_count
​integer · uint32

Total count of snapshots available.

Get a Database Instance snapshot

GET
https://api.scaleway.com
/rdb/v1/regions/{region}/snapshots/{snapshot_id}

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.

Get a Database Instance snapshot › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams
pl-waw
snapshot_id
​string · required

UUID of the snapshot.

Get a Database Instance snapshot › Responses

200
scaleway.rdb.v1.Snapshot
id
​string

UUID of the snapshot.

instance_id
​string

UUID of the Database Instance.

name
​string

Name of the snapshot.

status
​scaleway.rdb.v1.Snapshot.Status · enum

Status of the snapshot.

Enum values:
unknown
creating
ready
restoring
deleting
error
locked
Default: unknown
size
​integer | null · uint64

Size of the snapshot. (in bytes)

expires_at
​string | null · date-time

Expiration date (must follow the ISO 8601 format). (RFC 3339 format)

created_at
​string | null · date-time

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

updated_at
​string | null · date-time

Updated date (must follow the ISO 8601 format). (RFC 3339 format)

instance_name
​string

Name of the Database Instance of the snapshot.

node_type
​string

Source node type.

Type of volume where data is stored (lssd, bssd or sbs).

region
​string

Region of this snapshot.

Delete a Database Instance snapshot

DELETE
https://api.scaleway.com
/rdb/v1/regions/{region}/snapshots/{snapshot_id}

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.

Delete a Database Instance snapshot › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams
pl-waw
snapshot_id
​string · required

UUID of the snapshot to delete.

Delete a Database Instance snapshot › Responses

200
scaleway.rdb.v1.Snapshot
id
​string

UUID of the snapshot.

instance_id
​string

UUID of the Database Instance.

name
​string

Name of the snapshot.

status
​scaleway.rdb.v1.Snapshot.Status · enum

Status of the snapshot.

Enum values:
unknown
creating
ready
restoring
deleting
error
locked
Default: unknown
size
​integer | null · uint64

Size of the snapshot. (in bytes)

expires_at
​string | null · date-time

Expiration date (must follow the ISO 8601 format). (RFC 3339 format)

created_at
​string | null · date-time

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

updated_at
​string | null · date-time

Updated date (must follow the ISO 8601 format). (RFC 3339 format)

instance_name
​string

Name of the Database Instance of the snapshot.

node_type
​string

Source node type.

Type of volume where data is stored (lssd, bssd or sbs).

region
​string

Region of this snapshot.

Update a Database Instance snapshot

PATCH
https://api.scaleway.com
/rdb/v1/regions/{region}/snapshots/{snapshot_id}

Update the parameters of a snapshot of a Database Instance. You can update the name and expires_at parameters.

Update a Database Instance snapshot › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams
pl-waw
snapshot_id
​string · required

UUID of the snapshot to update.

Update a Database Instance snapshot › Request Body

name
​string | null

Name of the snapshot.

expires_at
​string | null · date-time

Expiration date (must follow the ISO 8601 format). (RFC 3339 format)

Update a Database Instance snapshot › Responses

200
scaleway.rdb.v1.Snapshot
id
​string

UUID of the snapshot.

instance_id
​string

UUID of the Database Instance.

name
​string

Name of the snapshot.

status
​scaleway.rdb.v1.Snapshot.Status · enum

Status of the snapshot.

Enum values:
unknown
creating
ready
restoring
deleting
error
locked
Default: unknown
size
​integer | null · uint64

Size of the snapshot. (in bytes)

expires_at
​string | null · date-time

Expiration date (must follow the ISO 8601 format). (RFC 3339 format)

created_at
​string | null · date-time

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

updated_at
​string | null · date-time

Updated date (must follow the ISO 8601 format). (RFC 3339 format)

instance_name
​string

Name of the Database Instance of the snapshot.

node_type
​string

Source node type.

Type of volume where data is stored (lssd, bssd or sbs).

region
​string

Region of this snapshot.

Create a new Database Instance from a snapshot

POST
https://api.scaleway.com
/rdb/v1/regions/{region}/snapshots/{snapshot_id}/create-instance

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.

Create a new Database Instance from a snapshot › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams
pl-waw
snapshot_id
​string · required

Block snapshot of the Database Instance.

Create a new Database Instance from a snapshot › Request Body

instance_name
​string

Name of the Database Instance created with the snapshot.

high_availability_mode
​scaleway.rdb.v1.HighAvailabilityMode · enum

Defines the High-Availability mode of the instance.

Enum values:
unknown_high_availability_mode
disabled
single_zone
multiple_zone
Default: unknown_high_availability_mode
node_type
​string | null

The node type used to restore the snapshot.

Create a new Database Instance from a snapshot › Responses

200
scaleway.rdb.v1.Instance
created_at
​string | null · date-time

Creation date (must follow the ISO 8601 format). (RFC 3339 format)

Volumes of the Database Instance.

region
​string

Region the Database Instance is in.

id
​string

UUID of the Database Instance. (UUID format)

name
​string

Name of the Database Instance.

organization_id
​string

Organization ID the Database Instance belongs to. (UUID format)

project_id
​string

Project ID the Database Instance belongs to. (UUID format)

status
​scaleway.rdb.v1.Instance.Status · enum

Status of the Database Instance.

Enum values:
unknown
ready
provisioning
configuring
deleting
error
autohealing
locked
Default: unknown
engine
​string

Database engine of the database (PostgreSQL, MySQL, ...).

​scaleway.rdb.v1.UpgradableVersion[]

Available database engine versions for upgrade.

tags
​string[]

List of tags applied to the Database Instance.

Advanced settings of the Database Instance.

​scaleway.rdb.v1.BackupSchedule

Backup schedule of the Database Instance.

is_ha_cluster
​boolean

Defines whether or not High-Availability is enabled.

high_availability_mode
​scaleway.rdb.v1.HighAvailabilityMode · enum

Defines the High-Availability mode of the instance.

Enum values:
unknown_high_availability_mode
disabled
single_zone
multiple_zone
Default: unknown_high_availability_mode
​scaleway.rdb.v1.ReadReplica[]

Read Replicas of the Database Instance.

node_type
​string

Node type of the Database Instance.

List of engine settings to be set at database initialization.

List of Database Instance endpoints.

​scaleway.rdb.v1.LogsPolicy

Logs policy of the Database Instance.

backup_same_region
​boolean

Store logical backups in the same region as the Database Instance.

​scaleway.rdb.v1.Maintenance[]

List of Database Instance maintenance events.

Encryption at rest settings for your Database Instance.

NodeTypesEndpoints