Managed Database for PostgreSQL and MySQL API

Backups

A database backup is a dated export of a Database Instance stored on an offsite backend located in a different region than your database, by default. Once a backup is created, it can be used to restore the database. Each logical database in a Database Instance is backed up and can be restored separately.

List database backups

GET

https://api.scaleway.com

/rdb/v1/regions/{region}/backups

List all backups in a specified region, for a given Scaleway Organization or Scaleway Project. By default, the backups listed are ordered by creation date in ascending order. This can be modified via the order_by field.

List database backups › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

List database backups › query Parameters

name

string

Name of the database backups.

order_by

scaleway.rdb.v1.ListDatabaseBackupsRequest.OrderBy · enum

Criteria to use when ordering database backups listing.

Enum values:

created_at_asc

created_at_desc

name_asc

name_desc

status_asc

status_desc

Default: created_at_asc

instance_id

string

UUID of the Database Instance.

organization_id

string

Organization ID of the Organization the database backups belong to.

project_id

string

Project ID of the Project the database backups belong to.

page

google.protobuf.Int32Value · int32

page_size

integer · uint32

List database backups › Responses

200

scaleway.rdb.v1.ListDatabaseBackupsResponse

scaleway.rdb.v1.DatabaseBackup[]

List of database backups.

total_count

integer · uint32

Total count of database backups available.

Create a database backup

POST

https://api.scaleway.com

/rdb/v1/regions/{region}/backups

Create a new backup. You must set the instance_id, database_name, name and expires_at parameters.

Create a database backup › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

Create a database backup › Request Body

instance_id

string · required

UUID of the Database Instance.

database_name

string · required

Name of the database you want to back up.

name

string

Name of the backup.

expires_at

string | null · date-time

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

Create a database backup › Responses

200

scaleway.rdb.v1.DatabaseBackup

id

string

UUID of the database backup.

instance_id

string

UUID of the Database Instance.

database_name

string

Name of backed up database.

name

string

Name of the backup.

status

scaleway.rdb.v1.DatabaseBackup.Status · enum

Status of the backup.

Enum values:

unknown

creating

ready

restoring

deleting

error

exporting

locked

Default: unknown

size

integer | null · uint64

Size of the database backup. (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 backup.

download_url

string | null

URL you can download the backup from.

download_url_expires_at

string | null · date-time

Expiration date of the download link. (RFC 3339 format)

region

string

Region of the database backup.

same_region

boolean

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

POST/rdb/v1/regions/{region}/backups

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "database_name": "string",
    "instance_id": "string",
    "name": "string"
  }' \
  "https://api.scaleway.com/rdb/v1/regions/{region}/backups"

Example Request Body

{
  "instance_id": "instance_id",
  "database_name": "database_name",
  "name": "name",
  "expires_at": "2022-03-22T12:34:56.123456Z"
}

json

Example Responses

{
  "id": "id",
  "instance_id": "instance_id",
  "database_name": "database_name",
  "name": "name",
  "status": "unknown",
  "size": 0,
  "expires_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "instance_name": "instance_name",
  "download_url": "download_url",
  "download_url_expires_at": "2022-03-22T12:34:56.123456Z",
  "region": "region",
  "same_region": true
}

json

application/json

Get a database backup

GET

https://api.scaleway.com

/rdb/v1/regions/{region}/backups/{database_backup_id}

Retrieve information about a given backup, specified by its database backup ID and region. Full details about the backup, like size, URL and expiration date, are returned in the response.

Get a database backup › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

database_backup_id

string · required

UUID of the database backup.

Get a database backup › Responses

200

scaleway.rdb.v1.DatabaseBackup

id

string

UUID of the database backup.

instance_id

string

UUID of the Database Instance.

database_name

string

Name of backed up database.

name

string

Name of the backup.

status

scaleway.rdb.v1.DatabaseBackup.Status · enum

Status of the backup.

Enum values:

unknown

creating

ready

restoring

deleting

error

exporting

locked

Default: unknown

size

integer | null · uint64

Size of the database backup. (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 backup.

download_url

string | null

URL you can download the backup from.

download_url_expires_at

string | null · date-time

Expiration date of the download link. (RFC 3339 format)

region

string

Region of the database backup.

same_region

boolean

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

Delete a database backup

DELETE

https://api.scaleway.com

/rdb/v1/regions/{region}/backups/{database_backup_id}

Delete a backup, specified by its database backup ID and region. Deleting a backup is permanent, and cannot be undone.

Delete a database backup › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

database_backup_id

string · required

UUID of the database backup to delete.

Delete a database backup › Responses

200

scaleway.rdb.v1.DatabaseBackup

id

string

UUID of the database backup.

instance_id

string

UUID of the Database Instance.

database_name

string

Name of backed up database.

name

string

Name of the backup.

status

scaleway.rdb.v1.DatabaseBackup.Status · enum

Status of the backup.

Enum values:

unknown

creating

ready

restoring

deleting

error

exporting

locked

Default: unknown

size

integer | null · uint64

Size of the database backup. (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 backup.

download_url

string | null

URL you can download the backup from.

download_url_expires_at

string | null · date-time

Expiration date of the download link. (RFC 3339 format)

region

string

Region of the database backup.

same_region

boolean

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

Update a database backup

PATCH

https://api.scaleway.com

/rdb/v1/regions/{region}/backups/{database_backup_id}

Update the parameters of a backup, including name and expiration date.

Update a database backup › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

database_backup_id

string · required

UUID of the database backup to update.

Update a database backup › Request Body

name

string | null

Name of the Database Backup.

expires_at

string | null · date-time

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

Update a database backup › Responses

200

scaleway.rdb.v1.DatabaseBackup

id

string

UUID of the database backup.

instance_id

string

UUID of the Database Instance.

database_name

string

Name of backed up database.

name

string

Name of the backup.

status

scaleway.rdb.v1.DatabaseBackup.Status · enum

Status of the backup.

Enum values:

unknown

creating

ready

restoring

deleting

error

exporting

locked

Default: unknown

size

integer | null · uint64

Size of the database backup. (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 backup.

download_url

string | null

URL you can download the backup from.

download_url_expires_at

string | null · date-time

Expiration date of the download link. (RFC 3339 format)

region

string

Region of the database backup.

same_region

boolean

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

PATCH/rdb/v1/regions/{region}/backups/{database_backup_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/rdb/v1/regions/{region}/backups/{database_backup_id}"

Example Request Body

{
  "name": "name",
  "expires_at": "2022-03-22T12:34:56.123456Z"
}

json

Example Responses

{
  "id": "id",
  "instance_id": "instance_id",
  "database_name": "database_name",
  "name": "name",
  "status": "unknown",
  "size": 0,
  "expires_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "instance_name": "instance_name",
  "download_url": "download_url",
  "download_url_expires_at": "2022-03-22T12:34:56.123456Z",
  "region": "region",
  "same_region": true
}

json

application/json

Export a database backup

POST

https://api.scaleway.com

/rdb/v1/regions/{region}/backups/{database_backup_id}/export

Export a backup, specified by the database_backup_id and the region parameters. The download URL is returned in the response.

Export a database backup › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

database_backup_id

string · required

UUID of the database backup you want to export.

Export a database backup › Request Body

Export a database backup › Responses

200

scaleway.rdb.v1.DatabaseBackup

id

string

UUID of the database backup.

instance_id

string

UUID of the Database Instance.

database_name

string

Name of backed up database.

name

string

Name of the backup.

status

scaleway.rdb.v1.DatabaseBackup.Status · enum

Status of the backup.

Enum values:

unknown

creating

ready

restoring

deleting

error

exporting

locked

Default: unknown

size

integer | null · uint64

Size of the database backup. (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 backup.

download_url

string | null

URL you can download the backup from.

download_url_expires_at

string | null · date-time

Expiration date of the download link. (RFC 3339 format)

region

string

Region of the database backup.

same_region

boolean

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

Restore a database backup

POST

https://api.scaleway.com

/rdb/v1/regions/{region}/backups/{database_backup_id}/restore

Launch the process of restoring database backup. You must specify the instance_id of the Database Instance of destination, where the backup will be restored. Note that large database backups can take up to several hours to restore.

Restore a database backup › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

database_backup_id

string · required

Backup of a logical database.

Restore a database backup › Request Body

instance_id

string · required

Defines the Database Instance where the backup has to be restored.

database_name

string | null

Defines the destination database to restore into a specified database (the default destination is set to the origin database of the backup).

Restore a database backup › Responses

200

scaleway.rdb.v1.DatabaseBackup

id

string

UUID of the database backup.

instance_id

string

UUID of the Database Instance.

database_name

string

Name of backed up database.

name

string

Name of the backup.

status

scaleway.rdb.v1.DatabaseBackup.Status · enum

Status of the backup.

Enum values:

unknown

creating

ready

restoring

deleting

error

exporting

locked

Default: unknown

size

integer | null · uint64

Size of the database backup. (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 backup.

download_url

string | null

URL you can download the backup from.

download_url_expires_at

string | null · date-time

Expiration date of the download link. (RFC 3339 format)

region

string

Region of the database backup.

same_region

boolean

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

POST/rdb/v1/regions/{region}/backups/{database_backup_id}/restore

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"instance_id":"string"}' \
  "https://api.scaleway.com/rdb/v1/regions/{region}/backups/{database_backup_id}/restore"

Example Request Body

{
  "database_name": "database_name",
  "instance_id": "instance_id"
}

json

Example Responses

{
  "id": "id",
  "instance_id": "instance_id",
  "database_name": "database_name",
  "name": "name",
  "status": "unknown",
  "size": 0,
  "expires_at": "2022-03-22T12:34:56.123456Z",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "instance_name": "instance_name",
  "download_url": "download_url",
  "download_url_expires_at": "2022-03-22T12:34:56.123456Z",
  "region": "region",
  "same_region": true
}

json

application/json

Engines