openapi: 3.1.0
info:
title: Managed Database for PostgreSQL and MySQL Access Control List Database Instances 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: Database Instances
description: 'A Database Instance is made up of one or multiple dedicated compute nodes running a single database engine. Two node settings are available: **High-Availability (HA)**, with a main node and one replica, and **standalone** with a main node. The HA standby node is linked to the main node, using synchronous replication. Synchronous replication offers the ability to confirm that all changes intended by a transaction have been transferred and applied to the synchronous replica node, providing durability to the data.
**Note**: HA standby nodes are not accessible to users unless the main node becomes unavailable and the standby takes over. If you wish to run queries on a read-only node, you can use [Read Replicas](#path-read-replicas-create-a-read-replica)
Read Replicas can be used for certain read-only workflows such as Business Intelligence, or for a read-only scaling of your application. Read Replicas use asynchronous replication to replicate data from the main node.
'
paths:
/rdb/v1/regions/{region}/instances:
get:
tags:
- Database Instances
operationId: ListInstances
summary: List Database Instances
description: List all Database Instances in the specified region, for a given Scaleway Organization or Scaleway Project. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter.
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: tags
description: List Database Instances that have a given tag.
schema:
type: array
items:
type: string
- in: query
name: name
description: Lists Database Instances that match a name pattern.
schema:
type: string
- in: query
name: order_by
description: Criteria to use when ordering Database Instance listings.
schema:
type: string
enum:
- created_at_asc
- created_at_desc
- name_asc
- name_desc
- region
- status_asc
- status_desc
default: created_at_asc
- in: query
name: organization_id
description: Please use project_id instead.
schema:
type: string
- in: query
name: project_id
description: Project ID to list the Database Instance of.
schema:
type: string
- in: query
name: has_maintenances
description: Filter to only list instances with a scheduled maintenance.
schema:
type: boolean
- 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.ListInstancesResponse'
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}/instances\""
- lang: HTTPie
source: "http GET \"https://api.scaleway.com/rdb/v1/regions/{region}/instances\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
post:
tags:
- Database Instances
operationId: CreateInstance
summary: Create a Database Instance
description: Create a new Database Instance. You must set the `engine`, `user_name`, `password` and `node_type` parameters. Optionally, you can specify the volume type and size.
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.Instance'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
organization_id:
type: string
description: Please use project_id instead.
deprecated: true
nullable: true
x-one-of: ProjectIdentifier
project_id:
type: string
description: The Project ID on which the Database Instance will be created.
nullable: true
x-one-of: ProjectIdentifier
name:
type: string
description: Name of the Database Instance.
engine:
type: string
description: Database engine of the Database Instance (PostgreSQL, MySQL, ...).
user_name:
type: string
description: Username created when the Database Instance is created.
password:
type: string
description: Password of the user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character.
node_type:
type: string
description: Type of node to use for the Database Instance.
is_ha_cluster:
type: boolean
description: Defines whether or not High-Availability is enabled.
disable_backup:
type: boolean
description: Defines whether or not backups are disabled.
tags:
type: array
description: Tags to apply to the Database Instance.
items:
type: string
init_settings:
type: array
description: List of engine settings to be set upon Database Instance initialization.
items:
$ref: '#/components/schemas/scaleway.rdb.v1.InstanceSetting'
volume_type:
type: string
description: Type of volume where data is stored (lssd, bssd, ...).
enum:
- lssd
- bssd
- sbs_5k
- sbs_15k
default: lssd
volume_size:
type: integer
description: Volume size when volume_type is not lssd. (in bytes)
format: uint64
init_endpoints:
type: array
description: One or multiple EndpointSpec used to expose your Database Instance. A load_balancer public endpoint is systematically created.
items:
$ref: '#/components/schemas/scaleway.rdb.v1.EndpointSpec'
backup_same_region:
type: boolean
description: Defines whether to or not to store logical backups in the same region as the Database Instance.
encryption:
type: object
description: Encryption at rest settings for your Database Instance.
properties:
enabled:
type: boolean
x-properties-order:
- enabled
required:
- engine
- user_name
- password
- node_type
x-properties-order:
- organization_id
- project_id
- name
- engine
- user_name
- password
- node_type
- is_ha_cluster
- disable_backup
- tags
- init_settings
- volume_type
- volume_size
- init_endpoints
- backup_same_region
- encryption
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 \"backup_same_region\": false,\n \"disable_backup\": false,\n \"engine\": \"string\",\n \"is_ha_cluster\": false,\n \"name\": \"string\",\n \"node_type\": \"string\",\n \"password\": \"string\",\n \"user_name\": \"string\",\n \"volume_size\": 42\n }' \\\n \"https://api.scaleway.com/rdb/v1/regions/{region}/instances\""
- lang: HTTPie
source: "http POST \"https://api.scaleway.com/rdb/v1/regions/{region}/instances\" \\\n X-Auth-Token:$SCW_SECRET_KEY \\\n backup_same_region:=false \\\n disable_backup:=false \\\n engine=\"string\" \\\n is_ha_cluster:=false \\\n name=\"string\" \\\n node_type=\"string\" \\\n password=\"string\" \\\n user_name=\"string\" \\\n volume_size:=42"
/rdb/v1/regions/{region}/instances/{instance_id}:
get:
tags:
- Database Instances
operationId: GetInstance
summary: Get a Database Instance
description: Retrieve information about a given Database Instance, specified by the `region` and `instance_id` parameters. Its full details, including name, status, IP address and port, are returned in the response object.
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: instance_id
description: UUID of the Database Instance.
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.rdb.v1.Instance'
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}/instances/{instance_id}\""
- lang: HTTPie
source: "http GET \"https://api.scaleway.com/rdb/v1/regions/{region}/instances/{instance_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
patch:
tags:
- Database Instances
operationId: UpdateInstance
summary: Update a Database Instance
description: Update the parameters of a Database Instance, including name, tags and backup schedule details.
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: instance_id
description: UUID of the Database Instance to update.
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.rdb.v1.Instance'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
backup_schedule_frequency:
type: integer
description: In hours.
format: uint32
nullable: true
backup_schedule_retention:
type: integer
description: In days.
format: uint32
nullable: true
is_backup_schedule_disabled:
type: boolean
description: Defines whether or not the backup schedule is disabled.
nullable: true
name:
type: string
description: Name of the Database Instance.
nullable: true
tags:
type: array
description: Tags of a Database Instance.
nullable: true
items:
type: string
logs_policy:
type: object
description: Logs policy of the Database Instance.
properties:
max_age_retention:
type: integer
description: Max age (in days) of remote logs to keep on the Database Instance.
format: uint32
nullable: true
total_disk_retention:
type: integer
description: Max disk size of remote logs to keep on the Database Instance. (in bytes)
format: uint64
nullable: true
x-properties-order:
- max_age_retention
- total_disk_retention
backup_same_region:
type: boolean
description: Store logical backups in the same region as the Database Instance.
nullable: true
backup_schedule_start_hour:
type: integer
description: Defines the start time of the autobackup.
format: uint32
nullable: true
x-properties-order:
- backup_schedule_frequency
- backup_schedule_retention
- is_backup_schedule_disabled
- name
- tags
- logs_policy
- backup_same_region
- backup_schedule_start_hour
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}/instances/{instance_id}\""
- lang: HTTPie
source: "http PATCH \"https://api.scaleway.com/rdb/v1/regions/{region}/instances/{instance_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
delete:
tags:
- Database Instances
operationId: DeleteInstance
summary: Delete a Database Instance
description: Delete a given Database Instance, specified by the `region` and `instance_id` parameters. Deleting a Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost.
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: instance_id
description: UUID of the Database Instance to delete.
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.rdb.v1.Instance'
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}/instances/{instance_id}\""
- lang: HTTPie
source: "http DELETE \"https://api.scaleway.com/rdb/v1/regions/{region}/instances/{instance_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
/rdb/v1/regions/{region}/instances/{instance_id}/apply-maintenance:
post:
tags:
- Database Instances
operationId: ApplyInstanceMaintenance
summary: Apply Database Instance maintenance
description: Apply maintenance tasks to your Database Instance. This will trigger pending maintenance tasks to start in your Database Instance and can generate service interruption. Maintenance tasks can be applied between `starts_at` and `stops_at` times, and are run directly by Scaleway at `forced_at` timestamp.
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: instance_id
description: UUID of the Database Instance you want to apply maintenance.
required: true
schema:
type: string
# --- truncated at 32 KB (75 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/scaleway/refs/heads/main/openapi/scaleway-database-instances-api-openapi.yml