openapi: 3.1.0
info:
title: Managed Database for PostgreSQL and MySQL Access Control List Backups API
description: "Managed Database for PostgreSQL and MySQL provides fully-managed relational Database Instances, with MySQL or PostgreSQL as database engines. The resource allows you to focus on development rather than administration or configuration. It comes with a high-availability mode, data replication, and automatic backups.\n\nCompared to traditional database management, which requires customers to provide their infrastructure and resources to manage their databases, Managed Database for PostgreSQL and MySQL Instance offers the user access to Database Instances without setting up the hardware or configuring the software. Scaleway handles the provisioning, manages the configuration, and provides useful features as high availability, automated backup, user management, and more.\n\n\n\n\n## Concepts\n\nRefer to our [dedicated concepts page](https://www.scaleway.com/en/docs/managed-databases-for-postgresql-and-mysql/concepts/) to find definitions of the different terms referring to Managed Database for PostgreSQL and MySQL.\n\n\n\n\n## Quickstart\n\n1. Configure your environment variables.\n <Message type=\"note\">\n This is an optional step that seeks to simplify your usage of the APIs.\n </Message>\n\n ```bash\n export SCW_ACCESS_KEY=\"<API access key>\"\n export SCW_SECRET_KEY=\"<API secret key>\"\n export SCW_REGION=\"<Scaleway region>\"\n ```\n2. Edit the POST request payload you will use to create your Database Instance. Replace the parameters in the following example:\n ```json\n '{\n \"project_id\": \"d8e65f2b-cce9-40b7-80fc-6a2902db6826\",\n \"name\": \"myDB\",\n \"engine\": \"PostgreSQL-15\",\n \"tags\": [\"donnerstag\"],\n \"is_ha_cluster\": true,\n \"node_type\": \"db-pro2-xxs\",\n \"disable_backup\": false,\n \"user_name\": \"my_initial_user\",\n \"password\": \"thiZ_is_v0ry_s3cret\",\n \"volume_type\": \"sbs_5k\",\n \"volume_size\": \"30000000000\"\n }'\n ```\n\n | Parameter | Description |\n | :--------------- |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n | `project_id` | The ID of the Project you want to create your Database Instance in. To find your Project ID you can **[list the projects](/api/account/project-api/#path-projects-list-all-projects-of-an-organization)** or consult the **[Scaleway console](https://console.scaleway.com/project/settings)**. |\n | `engine` | **REQUIRED** Version ID of the database engine. To check the list of available engines you can use the following endpoint: `https://api.scaleway.com/rdb/v1/regions/$SCW_REGION/database-engines` |\n | `name` | Name of the Database Instance |\n | `node_type` | **REQUIRED** The node type. To check the list of available node types you can use the following endpoint: `https://api.scaleway.com/rdb/v1/regions/$SCW_REGION/node-types` |\n | `is_ha_cluster` | **BOOLEAN** Defines whether High Availability is enabled for the Database Instance |\n | `disable_backup` | **BOOLEAN** Defines whether automated backups are disabled for the Database Instance |\n | `tags` | The list of tags `[\"tag1\", \"tag2\", ...]` that will be associated with the Database Instance. Tags can be appended to the query of the [List Database Instances](#path-database-instances-list-database-instances) call to show results for only the Database Instances using a specific tag. You can also combine tags to list Database Instances that possess all the appended tags. |\n | `user_name` | **REQUIRED** Identifier of the default user, which is created concurrently with the Database Instance |\n | `password` | **REQUIRED** Password for the default user |\n | `volume_type` | Type of volume where data is stored. You can specify either local volume (`lssd`) or block volume (`bssd`, `sbs_5k` or `sbs_15k`). The default value is `lssd` |\n | `volume_size` | Volume size when volume_type is `bssd`, `sbs_5k` or `sbs_15k`. The value should be expressed in bytes. For example 30GB is expressed as 30000000000 |\n3. Create a Database Instance by running the following command. Make sure you include the payload you edited in the previous step.\n ```bash\n curl -X POST \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"Content-Type: application/json\" \\\n https://api.scaleway.com/rdb/v1/regions/$SCW_REGION/instances \\\n -d '{\n \"project_id\": \"d8e65f2b-cce9-40b7-80fc-6a2902db6826\",\n \"name\": \"myDB\",\n \"engine\": \"PostgreSQL-15\",\n \"tags\": [\"donnerstag\"],\n \"is_ha_cluster\": true,\n \"node_type\": \"db-pro2-xxs\",\n \"disable_backup\": false,\n \"user_name\": \"my_initial_user\",\n \"password\": \"thiZ_is_v0ry_s3cret\",\n \"volume_type\": \"sbs_5k\",\n \"volume_size\": \"30000000000\"\n }'\n ```\n4. List your Database Instances.\n ```bash\n curl -X GET \\\n -H \"Content-Type: application/json\" \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" https://api.scaleway.com/rdb/v1/regions/$SCW_REGION/instances\n ```\n\n You should get a response like the following:\n\n <Message type=\"note\">\n This is a response example, the UUIDs and IP address displayed are not real.\n </Message>\n\n ```json\n {\n \"id\": \"f5122f66-fb50-4cef-aa02-487ef4fc1af0\",\n \"name\": \"myDB\",\n \"organization_id\": \"895693aa-3915-4896-8761-c2923b008be7\",\n \"project_id\": \"d8e65f2b-cce9-40b7-80fc-6a2902db6826\",\n \"status\": \"ready\",\n \"engine\": \"PostgreSQL-15\",\n \"endpoint\": {\n \"ip\": \"198.51.100.0\",\n \"port\": 22245,\n \"name\": null\n },\n \"tags\": [\n \"donnerstag\"\n ],\n \"settings\": [],\n \"backup_schedule\": {\n \"frequency\": 24,\n \"retention\": 7,\n \"disabled\": true\n },\n \"is_ha_cluster\": true,\n \"read_replicas\": [],\n \"node_type\": \"db-pro2-xxs\",\n \"volume\": {\n \"type\": \"sbs_5k\",\n \"size\": 30000000000\n }\n \"created_at\": \"2019-04-19T16:24:52.591417Z\",\n \"region\": \"fr-par\"\n }\n ```\n5. Retrieve your Database Instance IP and port from the response.\n <Message type=\"note\">\n In the example above, the IP and port are `198.51.100.0` and `22245`, respectively.\n </Message>\n6. Connect to your Database Instance with the database client of the engine you selected.\n For MySQL, run the following command:\n ```bash\n mysql -h <ip-address> --port <port> -p -u <user_name>\n ```\n\n For PostgreSQL, run:\n ```bash\n psql -h <ip-address> -p <port> -U <username> -d rdb\n ```\n\n For the recurring example, the command would look like:\n\n ```bash\n psql -h 198.51.100.0 -p 22245 -U my_initial_user -d rdb\n ```\n7. Enter the database password that you defined upon creation.\n\nYou are now connected to your Managed Database.\n\n\n<Message type=\"requirement\">\nTo perform the following steps, you must first ensure that:\n - you have an account and are logged into the [Scaleway console](https://console.scaleway.com/organization)\n - you have created an [API key](https://www.scaleway.com/en/docs/iam/how-to/create-api-keys/) and that the API key has sufficient [IAM permissions](https://www.scaleway.com/en/docs/iam/reference-content/permission-sets/) to perform the actions described on this page.\n - you have [installed `curl`](https://curl.se/download.html)\n</Message>\n\n\n## Technical Information\n\n### Regions\n\nScaleway's infrastructure is spread across different [regions and Availability Zones](https://www.scaleway.com/en/docs/account/reference-content/products-availability/).\n\nManaged Database for PostgreSQL and MySQL is available in the Paris, Amsterdam and Warsaw regions, which are represented by the following path parameters:\n\n- `fr-par`\n- `nl-ams`\n- `pl-waw`\n\n### PostgreSQL specifications\n\n#### Versions\n\nScaleway Database for PostgreSQL supports PostgreSQL versions 11, 12, 13, 14 and 15.\n\n#### System\n\nDifferent modules are available for installation, including TimescaleDB and PostGIS. Refer to the [Managed Database for PostgreSQL and MySQL FAQ page](https://www.scaleway.com/en/docs/managed-databases-for-postgresql-and-mysql/faq/#which-postgresql-extensions-are-available) for an extensive list of PostgreSQL extensions.\n\n#### Database Management\n\nYou can create logical databases through the Scaleway console, the Scaleway APIs or SQL.\n\n- databases created using the Scaleway console or the API are owned by an internal system user. These are called \"managed databases\".\n- databases created using SQL will be owned by the creator. These are called \"unmanaged databases\".\n\n### MySQL specifications\n\n#### Versions\n\nScaleway Database for MySQL supports MySQL 8.\n\n#### System\n\n- only the [InnoDB engine](https://dev.mysql.com/doc/refman/8.0/en/innodb-storage-engine.html) is supported\n- the [Global Transaction Identifier (GTID)](https://dev.mysql.com/doc/refman/8.0/en/replication-gtids-concepts.html) is enabled.\n- [`mysql_native_password`](https://dev.mysql.com/doc/refman/8.0/en/native-pluggable-authentication.html) (default) and [`caching_sha2_password`](https://dev.mysql.com/doc/refman/8.0/en/caching-sha2-pluggable-authentication.html) authentication are supported.\n\n#### User Management\n\n- users with an `admin` role have access to all logical databases and can create new ones.\n- users created via the API are authenticated using the default authentication plugin, which can be changed in the settings.\n\n## Technical Limitations\n\n### PostgreSQL\n\n#### User Management\n\n- users with an `admin` role have `CREATEROLE` and `CREATEDB` privileges.\n- users do NOT have `SUPERUSER` nor `REPLICATION` privileges.\n- permission management through the Scaleway console or API is only possible for the \"managed databases\".\n\n#### Backup and restoration\n\nDatabases that have been backed up and then restored retain the user permission settings in use at the time of backup. If you delete users after backup and then restore your backup in the same database, or if you restore a backup to a different database with different or no users, the permissions configured for them continue to exist, but with no associated owner. This error will put a stop to the restoration process.\n\nTo avoid this issue, we recommend you re-create the users you deleted. In the occasion you restore the backup to a new database, you must create new users with the same names.\n\n## Going Further\n\nFor more information about Managed Database for PostgreSQL and MySQL, you can check out the following pages:\n\n* [Managed Database for PostgreSQL and MySQL Documentation](https://www.scaleway.com/en/docs/managed-databases/postgresql-and-mysql/)\n* [Managed Database for PostgreSQL and MySQL FAQ](https://www.scaleway.com/en/docs/managed-databases-for-postgresql-and-mysql/faq/)\n* [Scaleway Slack Community](https://scaleway-community.slack.com/) join the #database channel\n* [Contact our support team](https://console.scaleway.com/support/tickets)\n\n### How to migrate a database\n\nIf you wish to migrate existing databases to a Managed Database for PostgreSQL or MySQL, you can refer to the [Migrating existing databases to a Database Instance](https://www.scaleway.com/en/docs/tutorials/migrate-databases-instance/) tutorial page.\n\n### Troubleshoooting\n\n#### Disk full status\n\nIf your Database Instance uses local storage, your local volume might eventually approach full capacity and shift to `disk_full` mode. This mode grants you enough space to either [upgrade your node type](https://www.scaleway.com/en/docs/managed-databases-for-postgresql-and-mysql/how-to/upgrade-version/#how-to-change-the-node-type) or [clear out space in your volume](https://www.scaleway.com/en/docs/managed-databases-for-postgresql-and-mysql/troubleshooting/disk-full/)."
version: v1
servers:
- url: https://api.scaleway.com
tags:
- name: Backups
description: '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.
'
paths:
/rdb/v1/regions/{region}/backups:
get:
tags:
- Backups
operationId: ListDatabaseBackups
summary: List database backups
description: 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.
parameters:
- in: path
name: region
description: The region you want to target
required: true
schema:
type: string
enum:
- fr-par
- nl-ams
- pl-waw
- in: query
name: name
description: Name of the database backups.
schema:
type: string
- in: query
name: order_by
description: Criteria to use when ordering database backups listing.
schema:
type: string
enum:
- created_at_asc
- created_at_desc
- name_asc
- name_desc
- status_asc
- status_desc
default: created_at_asc
- in: query
name: instance_id
description: UUID of the Database Instance.
schema:
type: string
- in: query
name: organization_id
description: Organization ID of the Organization the database backups belong to.
schema:
type: string
- in: query
name: project_id
description: Project ID of the Project the database backups belong to.
schema:
type: string
- in: query
name: page
schema:
$ref: '#/components/schemas/google.protobuf.Int32Value'
- in: query
name: page_size
schema:
type: integer
format: uint32
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.rdb.v1.ListDatabaseBackupsResponse'
security:
- scaleway: []
x-codeSamples:
- lang: cURL
source: "curl -X GET \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/rdb/v1/regions/{region}/backups\""
- lang: HTTPie
source: "http GET \"https://api.scaleway.com/rdb/v1/regions/{region}/backups\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
post:
tags:
- Backups
operationId: CreateDatabaseBackup
summary: Create a database backup
description: Create a new backup. You must set the `instance_id`, `database_name`, `name` and `expires_at` parameters.
parameters:
- in: path
name: region
description: The region you want to target
required: true
schema:
type: string
enum:
- fr-par
- nl-ams
- pl-waw
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.rdb.v1.DatabaseBackup'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
instance_id:
type: string
description: UUID of the Database Instance.
database_name:
type: string
description: Name of the database you want to back up.
name:
type: string
description: Name of the backup.
expires_at:
type: string
description: Expiration date (must follow the ISO 8601 format). (RFC 3339 format)
format: date-time
example: '2022-03-22T12:34:56.123456Z'
nullable: true
required:
- instance_id
- database_name
x-properties-order:
- instance_id
- database_name
- name
- expires_at
security:
- scaleway: []
x-codeSamples:
- lang: cURL
source: "curl -X POST \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"database_name\": \"string\",\n \"instance_id\": \"string\",\n \"name\": \"string\"\n }' \\\n \"https://api.scaleway.com/rdb/v1/regions/{region}/backups\""
- lang: HTTPie
source: "http POST \"https://api.scaleway.com/rdb/v1/regions/{region}/backups\" \\\n X-Auth-Token:$SCW_SECRET_KEY \\\n database_name=\"string\" \\\n instance_id=\"string\" \\\n name=\"string\""
/rdb/v1/regions/{region}/backups/{database_backup_id}:
get:
tags:
- Backups
operationId: GetDatabaseBackup
summary: Get a database backup
description: 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.
parameters:
- in: path
name: region
description: The region you want to target
required: true
schema:
type: string
enum:
- fr-par
- nl-ams
- pl-waw
- in: path
name: database_backup_id
description: UUID of the database backup.
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.rdb.v1.DatabaseBackup'
security:
- scaleway: []
x-codeSamples:
- lang: cURL
source: "curl -X GET \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/rdb/v1/regions/{region}/backups/{database_backup_id}\""
- lang: HTTPie
source: "http GET \"https://api.scaleway.com/rdb/v1/regions/{region}/backups/{database_backup_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
patch:
tags:
- Backups
operationId: UpdateDatabaseBackup
summary: Update a database backup
description: Update the parameters of a backup, including name and expiration date.
parameters:
- in: path
name: region
description: The region you want to target
required: true
schema:
type: string
enum:
- fr-par
- nl-ams
- pl-waw
- in: path
name: database_backup_id
description: UUID of the database backup to update.
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.rdb.v1.DatabaseBackup'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Name of the Database Backup.
nullable: true
expires_at:
type: string
description: Expiration date (must follow the ISO 8601 format). (RFC 3339 format)
format: date-time
example: '2022-03-22T12:34:56.123456Z'
nullable: true
x-properties-order:
- name
- expires_at
security:
- scaleway: []
x-codeSamples:
- lang: cURL
source: "curl -X PATCH \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{}' \\\n \"https://api.scaleway.com/rdb/v1/regions/{region}/backups/{database_backup_id}\""
- lang: HTTPie
source: "http PATCH \"https://api.scaleway.com/rdb/v1/regions/{region}/backups/{database_backup_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
delete:
tags:
- Backups
operationId: DeleteDatabaseBackup
summary: Delete a database backup
description: Delete a backup, specified by its database backup ID and region. Deleting a backup is permanent, and cannot be undone.
parameters:
- in: path
name: region
description: The region you want to target
required: true
schema:
type: string
enum:
- fr-par
- nl-ams
- pl-waw
- in: path
name: database_backup_id
description: UUID of the database backup to delete.
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.rdb.v1.DatabaseBackup'
security:
- scaleway: []
x-codeSamples:
- lang: cURL
source: "curl -X DELETE \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/rdb/v1/regions/{region}/backups/{database_backup_id}\""
- lang: HTTPie
source: "http DELETE \"https://api.scaleway.com/rdb/v1/regions/{region}/backups/{database_backup_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
/rdb/v1/regions/{region}/backups/{database_backup_id}/export:
post:
tags:
- Backups
operationId: ExportDatabaseBackup
summary: Export a database backup
description: Export a backup, specified by the `database_backup_id` and the `region` parameters. The download URL is returned in the response.
parameters:
- in: path
name: region
description: The region you want to target
required: true
schema:
type: string
enum:
- fr-par
- nl-ams
- pl-waw
- in: path
name: database_backup_id
description: UUID of the database backup you want to export.
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.rdb.v1.DatabaseBackup'
requestBody:
required: true
content:
application/json:
schema:
type: object
security:
- scaleway: []
x-codeSamples:
- lang: cURL
source: "curl -X POST \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{}' \\\n \"https://api.scaleway.com/rdb/v1/regions/{region}/backups/{database_backup_id}/export\""
- lang: HTTPie
source: "http POST \"https://api.scaleway.com/rdb/v1/regions/{region}/backups/{database_backup_id}/export\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
/rdb/v1/regions/{region}/backups/{database_backup_id}/restore:
post:
tags:
- Backups
operationId: RestoreDatabaseBackup
summary: Restore a database backup
description: 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.
parameters:
- in: path
name: region
description: The region you want to target
required: true
schema:
type: string
enum:
- fr-par
- nl-ams
- pl-waw
- in: path
name: database_backup_id
description: Backup of a logical database.
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.rdb.v1.DatabaseBackup'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
database_name:
type: string
description: Defines the destination database to restore into a specified database (the default destination is set to the origin database of the backup).
nullable: true
instance_id:
type: string
description: Defines the Database Instance where the backup has to be restored.
required:
- instance_id
x-properties-order:
- database_name
- instance_id
security:
- scaleway: []
x-codeSamples:
- lang: cURL
source: "curl -X POST \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"instance_id\":\"string\"}' \\\n \"https://api.scaleway.com/rdb/v1/regions/{region}/backups/{database_backup_id}/restore\""
- lang: HTTPie
source: "http POST \"https://api.scaleway.com/rdb/v1/regions/{region}/backups/{database_backup_id}/restore\" \\\n X-Auth-Token:$SCW_SECRET_KEY \\\n instance_id=\"string\""
components:
schemas:
google.protobuf.Int32Value:
type: integer
format: int32
nullable: true
scaleway.rdb.v1.DatabaseBackup:
type: object
properties:
id:
type: string
description: UUID of the database backup.
instance_id:
type: string
description: UUID of the Database Instance.
database_name:
type: string
description: Name of backed up database.
name:
type: string
description: Name of the backup.
status:
type: string
description: Status of the backup.
enum:
- unknown
- creating
- ready
- restoring
- deleting
- error
- exporting
- locked
default: unknown
size:
type: integer
description: Size of the database backup. (in bytes)
format: uint64
nullable: true
expires_at:
type: string
description: Expiration date (must follow the ISO 8601 format). (RFC 3339 format)
format: date-time
example: '2022-03-22T12:34:56.123456Z'
nullable: true
created_at:
type: string
description: Creation date (must follow the ISO 8601 format). (RFC 3339 format)
format: date-time
example: '2022-03-22T12:34:56.123456Z'
nullable: true
updated_at:
type: string
description: Updated date (must follow the ISO 8601 format). (RFC 3339 format)
format: date-time
example: '2022-03-22T12:34:56.123456Z'
nullable: true
instance_name:
type: string
description: Name of the Database Instance of the backup.
download_url:
type: string
description: URL you can download the backup from.
nullable: true
download_url_expires_at:
type: string
description: Expiration date of the download link. (RFC 3339 format)
format: date-time
example: '2022-03-22T12:34:56.123456Z'
nullable: true
region:
type: string
description: Region of the database backup.
same_region:
type: boolean
description: Store logical backups in the same region as the source Database Instance.
x-properties-order:
- id
- instance_id
- database_name
- name
- status
- size
- expires_at
- created_at
- updated_at
- instance_name
- download_url
- download_url_expires_at
- region
- same_region
scaleway.rdb.v1.ListDatabaseBackupsResponse:
type: object
properties:
database_backups:
type: array
description: List of database backups.
items:
$ref: '#/components/schemas/scaleway.rdb.v1.DatabaseBackup'
total_count:
type: integer
description: Total count of database backups available.
format: uint32
x-properties-order:
- database_backups
- total_count
securitySchemes:
scaleway:
in: header
name: X-Auth-Token
type: apiKey