openapi: 3.1.0
info:
title: Managed Database for PostgreSQL and MySQL Access Control List VPCs 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: VPCs
description: 'A Virtual Private Cloud (VPC) allows you to group your regional
Private Networks together. Note that a Private Network can be a
part of only one VPC.
'
paths:
/vpc/v2/regions/{region}/vpcs:
get:
tags:
- VPCs
operationId: ListVPCs
summary: List VPCs
description: List existing VPCs in the specified region.
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: order_by
description: Sort order of the returned VPCs.
schema:
type: string
enum:
- created_at_asc
- created_at_desc
- name_asc
- name_desc
default: created_at_asc
- in: query
name: page
description: Page number to return, from the paginated results.
schema:
type: integer
format: int32
- in: query
name: page_size
description: Maximum number of VPCs to return per page.
schema:
type: integer
format: uint32
- in: query
name: name
description: Name to filter for. Only VPCs with names containing this string will be returned.
schema:
type: string
- in: query
name: tags
description: Tags to filter for. Only VPCs with one or more matching tags will be returned.
schema:
type: array
items:
type: string
- in: query
name: organization_id
description: Organization ID to filter for. Only VPCs belonging to this Organization will be returned. (UUID format)
schema:
type: string
example: 6170692e-7363-616c-6577-61792e636f6d
- in: query
name: project_id
description: Project ID to filter for. Only VPCs belonging to this Project will be returned. (UUID format)
schema:
type: string
example: 6170692e-7363-616c-6577-61792e636f6d
- in: query
name: is_default
description: Defines whether to filter only for VPCs which are the default one for their Project.
schema:
type: boolean
- in: query
name: routing_enabled
description: Defines whether to filter only for VPCs which route traffic between their Private Networks.
schema:
type: boolean
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.vpc.v2.ListVPCsResponse'
security:
- scaleway: []
x-codeSamples:
- lang: cURL
source: "curl -X GET \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/vpc/v2/regions/{region}/vpcs\""
- lang: HTTPie
source: "http GET \"https://api.scaleway.com/vpc/v2/regions/{region}/vpcs\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
post:
tags:
- VPCs
operationId: CreateVPC
summary: Create a VPC
description: Create a new VPC in the specified region.
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.vpc.v2.VPC'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Name for the VPC.
project_id:
type: string
description: Scaleway Project in which to create the VPC. (UUID format)
example: 6170692e-7363-616c-6577-61792e636f6d
tags:
type: array
description: Tags for the VPC.
items:
type: string
enable_routing:
type: boolean
description: Enable routing between Private Networks in the VPC.
required:
- name
- project_id
x-properties-order:
- name
- project_id
- tags
- enable_routing
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 \"enable_routing\": false,\n \"name\": \"string\",\n \"project_id\": \"6170692e-7363-616c-6577-61792e636f6d\"\n }' \\\n \"https://api.scaleway.com/vpc/v2/regions/{region}/vpcs\""
- lang: HTTPie
source: "http POST \"https://api.scaleway.com/vpc/v2/regions/{region}/vpcs\" \\\n X-Auth-Token:$SCW_SECRET_KEY \\\n enable_routing:=false \\\n name=\"string\" \\\n project_id=\"6170692e-7363-616c-6577-61792e636f6d\""
/vpc/v2/regions/{region}/vpcs/{vpc_id}:
get:
tags:
- VPCs
operationId: GetVPC
summary: Get a VPC
description: Retrieve details of an existing VPC, specified by its VPC ID.
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: vpc_id
description: VPC ID. (UUID format)
required: true
schema:
type: string
example: 6170692e-7363-616c-6577-61792e636f6d
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.vpc.v2.VPC'
security:
- scaleway: []
x-codeSamples:
- lang: cURL
source: "curl -X GET \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/vpc/v2/regions/{region}/vpcs/{vpc_id}\""
- lang: HTTPie
source: "http GET \"https://api.scaleway.com/vpc/v2/regions/{region}/vpcs/{vpc_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
patch:
tags:
- VPCs
operationId: UpdateVPC
summary: Update VPC
description: Update parameters including name and tags of the specified VPC.
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: vpc_id
description: VPC ID. (UUID format)
required: true
schema:
type: string
example: 6170692e-7363-616c-6577-61792e636f6d
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.vpc.v2.VPC'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Name for the VPC.
nullable: true
tags:
type: array
description: Tags for the VPC.
nullable: true
items:
type: string
x-properties-order:
- name
- tags
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/vpc/v2/regions/{region}/vpcs/{vpc_id}\""
- lang: HTTPie
source: "http PATCH \"https://api.scaleway.com/vpc/v2/regions/{region}/vpcs/{vpc_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
delete:
tags:
- VPCs
operationId: DeleteVPC
summary: Delete a VPC
description: Delete a VPC specified by its VPC ID.
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: vpc_id
description: VPC ID. (UUID format)
required: true
schema:
type: string
example: 6170692e-7363-616c-6577-61792e636f6d
responses:
'204':
description: ''
security:
- scaleway: []
x-codeSamples:
- lang: cURL
source: "curl -X DELETE \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/vpc/v2/regions/{region}/vpcs/{vpc_id}\""
- lang: HTTPie
source: "http DELETE \"https://api.scaleway.com/vpc/v2/regions/{region}/vpcs/{vpc_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
/vpc/v2/regions/{region}/vpcs/{vpc_id}/enable-routing:
post:
tags:
- VPCs
operationId: EnableRouting
summary: Enable routing on a VPC
description: Enable routing on an existing VPC. Note that you will not be able to deactivate it afterwards.
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: vpc_id
description: VPC ID. (UUID format)
required: true
schema:
type: string
example: 6170692e-7363-616c-6577-61792e636f6d
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.vpc.v2.VPC'
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/vpc/v2/regions/{region}/vpcs/{vpc_id}/enable-routing\""
- lang: HTTPie
source: "http POST \"https://api.scaleway.com/vpc/v2/regions/{region}/vpcs/{vpc_id}/enable-routing\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
components:
schemas:
scaleway.vpc.v2.ListVPCsResponse:
type: object
properties:
vpcs:
type: array
items:
$ref: '#/components/schemas/scaleway.vpc.v2.VPC'
total_count:
type: integer
format: uint32
x-properties-order:
- vpcs
- total_count
scaleway.vpc.v2.VPC:
type: object
properties:
id:
type: string
description: VPC ID. (UUID format)
example: 6170692e-7363-616c-6577-61792e636f6d
name:
type: string
description: VPC name.
organization_id:
type: string
description: Scaleway Organization the VPC belongs to. (UUID format)
example: 6170692e-7363-616c-6577-61792e636f6d
project_id:
type: string
description: Scaleway Project the VPC belongs to. (UUID format)
example: 6170692e-7363-616c-6577-61792e636f6d
region:
type: string
description: Region of the VPC.
tags:
type: array
description: Tags for the VPC.
items:
type: string
is_default:
type: boolean
description: Defines whether the VPC is the default one for its Project.
created_at:
type: string
description: Date the VPC was created. (RFC 3339 format)
format: date-time
example: '2022-03-22T12:34:56.123456Z'
nullable: true
updated_at:
type: string
description: Date the VPC was last modified. (RFC 3339 format)
format: date-time
example: '2022-03-22T12:34:56.123456Z'
nullable: true
private_network_count:
type: integer
description: Number of Private Networks within this VPC.
format: uint32
routing_enabled:
type: boolean
description: Defines whether the VPC routes traffic between its Private Networks.
custom_routes_propagation_enabled:
type: boolean
description: Defines whether the VPC advertises custom routes between its Private Networks.
x-properties-order:
- id
- name
- organization_id
- project_id
- region
- tags
- is_default
- created_at
- updated_at
- private_network_count
- routing_enabled
- custom_routes_propagation_enabled
securitySchemes:
scaleway:
in: header
name: X-Auth-Token
type: apiKey