openapi: 3.1.0
info:
title: Managed Database for PostgreSQL and MySQL Access Control List Backends 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: Backends
description: The Load Balancer backend object. It represents a set of backend servers that the frontend forwards requests to using the specified configuration (port, protocol, proxy protocol etc). You can create multiple backends for each of your Load Balancers. Use the backends endpoint to create backends, list, manage and update them and their healthchecks / backend servers, and delete them as required
paths:
/lb/v1/zones/{zone}/backends/{backend_id}:
get:
tags:
- Backends
operationId: GetBackend
summary: Get a backend of a given Load Balancer
description: Get the full details of a given backend, specified by its backend ID. The response contains the backend's full configuration parameters including protocol, port and forwarding algorithm.
parameters:
- in: path
name: zone
description: The zone you want to target
required: true
schema:
type: string
enum:
- fr-par-1
- fr-par-2
- nl-ams-1
- nl-ams-2
- nl-ams-3
- pl-waw-1
- pl-waw-2
- pl-waw-3
- in: path
name: backend_id
description: Backend ID.
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.lb.v1.Backend'
security:
- scaleway: []
x-codeSamples:
- lang: cURL
source: "curl -X GET \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/lb/v1/zones/{zone}/backends/{backend_id}\""
- lang: HTTPie
source: "http GET \"https://api.scaleway.com/lb/v1/zones/{zone}/backends/{backend_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
put:
tags:
- Backends
operationId: UpdateBackend
summary: Update a backend of a given Load Balancer
description: Update a backend of a given Load Balancer, specified by its backend ID. Note that the request type is PUT and not PATCH. You must set all parameters.
parameters:
- in: path
name: zone
description: The zone you want to target
required: true
schema:
type: string
enum:
- fr-par-1
- fr-par-2
- nl-ams-1
- nl-ams-2
- nl-ams-3
- pl-waw-1
- pl-waw-2
- pl-waw-3
- in: path
name: backend_id
description: Backend ID.
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.lb.v1.Backend'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Backend name.
forward_protocol:
type: string
description: Protocol to be used by the backend when forwarding traffic to backend servers.
enum:
- tcp
- http
default: tcp
forward_port:
type: integer
description: Port to be used by the backend when forwarding traffic to backend servers.
format: int32
forward_port_algorithm:
type: string
description: Load balancing algorithm to be used when determining which backend server to forward new traffic to.
enum:
- roundrobin
- leastconn
- first
default: roundrobin
sticky_sessions:
type: string
description: Defines whether to activate sticky sessions (binding a particular session to a particular backend server) and the method to use if so. None disables sticky sessions. Cookie-based uses an HTTP cookie to stick a session to a backend server. Table-based uses the source (client) IP address to stick a session to a backend server.
enum:
- none
- cookie
- table
default: none
sticky_sessions_cookie_name:
type: string
description: Cookie name for cookie-based sticky sessions.
send_proxy_v2:
type: boolean
description: Deprecated in favor of proxy_protocol field.
deprecated: true
timeout_server:
type: number
description: Maximum allowed time for a backend server to process a request. (in milliseconds)
timeout_connect:
type: number
description: Maximum allowed time for establishing a connection to a backend server. (in milliseconds)
timeout_tunnel:
type: number
description: Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout). (in milliseconds)
on_marked_down_action:
type: string
description: Action to take when a backend server is marked as down.
enum:
- on_marked_down_action_none
- shutdown_sessions
default: on_marked_down_action_none
proxy_protocol:
type: string
description: Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software.
enum:
- proxy_protocol_unknown
- proxy_protocol_none
- proxy_protocol_v1
- proxy_protocol_v2
- proxy_protocol_v2_ssl
- proxy_protocol_v2_ssl_cn
default: proxy_protocol_unknown
failover_host:
type: string
description: Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
nullable: true
ssl_bridging:
type: boolean
description: Defines whether to enable SSL bridging between the Load Balancer and backend servers.
nullable: true
ignore_ssl_server_verify:
type: boolean
description: Defines whether the server certificate verification should be ignored.
nullable: true
redispatch_attempt_count:
type: integer
description: Whether to use another backend server on each attempt.
format: int32
nullable: true
max_retries:
type: integer
description: Number of retries when a backend server connection failed.
format: int32
nullable: true
max_connections:
type: integer
description: Maximum number of connections allowed per backend server.
format: int32
nullable: true
timeout_queue:
type: string
description: Maximum time for a request to be left pending in queue when `max_connections` is reached. (in seconds)
example: 2.5s
nullable: true
required:
- name
- forward_protocol
- forward_port
- forward_port_algorithm
- sticky_sessions
x-properties-order:
- name
- forward_protocol
- forward_port
- forward_port_algorithm
- sticky_sessions
- sticky_sessions_cookie_name
- send_proxy_v2
- timeout_server
- timeout_connect
- timeout_tunnel
- on_marked_down_action
- proxy_protocol
- failover_host
- ssl_bridging
- ignore_ssl_server_verify
- redispatch_attempt_count
- max_retries
- max_connections
- timeout_queue
security:
- scaleway: []
x-codeSamples:
- lang: cURL
source: "curl -X PUT \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"forward_port\": 42,\n \"forward_port_algorithm\": \"roundrobin\",\n \"forward_protocol\": \"tcp\",\n \"name\": \"string\",\n \"send_proxy_v2\": false,\n \"sticky_sessions\": \"none\",\n \"sticky_sessions_cookie_name\": \"string\"\n }' \\\n \"https://api.scaleway.com/lb/v1/zones/{zone}/backends/{backend_id}\""
- lang: HTTPie
source: "http PUT \"https://api.scaleway.com/lb/v1/zones/{zone}/backends/{backend_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY \\\n forward_port:=42 \\\n forward_port_algorithm=\"roundrobin\" \\\n forward_protocol=\"tcp\" \\\n name=\"string\" \\\n send_proxy_v2:=false \\\n sticky_sessions=\"none\" \\\n sticky_sessions_cookie_name=\"string\""
delete:
tags:
- Backends
operationId: DeleteBackend
summary: Delete a backend of a given Load Balancer
description: Delete a backend of a given Load Balancer, specified by its backend ID. This action is irreversible and cannot be undone.
parameters:
- in: path
name: zone
description: The zone you want to target
required: true
schema:
type: string
enum:
- fr-par-1
- fr-par-2
- nl-ams-1
- nl-ams-2
- nl-ams-3
- pl-waw-1
- pl-waw-2
- pl-waw-3
- in: path
name: backend_id
description: ID of the backend to delete.
required: true
schema:
type: string
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/lb/v1/zones/{zone}/backends/{backend_id}\""
- lang: HTTPie
source: "http DELETE \"https://api.scaleway.com/lb/v1/zones/{zone}/backends/{backend_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
/lb/v1/zones/{zone}/backends/{backend_id}/healthcheck:
put:
tags:
- Backends
operationId: UpdateHealthCheck
summary: Update a health check for a given backend
description: Update the configuration of the health check performed by a given backend to verify the health of its backend servers, identified by its backend ID. Note that the request type is PUT and not PATCH. You must set all parameters.
parameters:
- in: path
name: zone
description: The zone you want to target
required: true
schema:
type: string
enum:
- fr-par-1
- fr-par-2
- nl-ams-1
- nl-ams-2
- nl-ams-3
- pl-waw-1
- pl-waw-2
- pl-waw-3
- in: path
name: backend_id
description: Backend ID.
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.lb.v1.HealthCheck'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
port:
type: integer
description: Port to use for the backend server health check.
format: int32
check_delay:
type: number
description: Time to wait between two consecutive health checks. (in milliseconds)
check_timeout:
type: number
description: Maximum time a backend server has to reply to the health check. (in milliseconds)
check_max_retries:
type: integer
description: Number of consecutive unsuccessful health checks after which the server will be considered dead.
format: int32
check_send_proxy:
type: boolean
description: Defines whether proxy protocol should be activated for the health check.
tcp_config:
type: object
description: Object to configure a basic TCP health check.
nullable: true
x-one-of: Config
mysql_config:
type: object
description: Object to configure a MySQL health check. The check requires MySQL >=3.22 or <9.0. For older or newer versions, use a TCP health check.
properties:
user:
type: string
description: MySQL user to use for the health check.
nullable: true
x-properties-order:
- user
x-one-of: Config
pgsql_config:
type: object
description: Object to configure a PostgreSQL health check.
properties:
user:
type: string
description: PostgreSQL user to use for the health check.
nullable: true
x-properties-order:
- user
x-one-of: Config
ldap_config:
type: object
description: Object to configure an LDAP health check. The response is analyzed to find the LDAPv3 response message.
nullable: true
x-one-of: Config
redis_config:
type: object
description: Object to configure a Redis health check. The response is analyzed to find the +PONG response message.
nullable: true
x-one-of: Config
http_config:
type: object
description: Object to configure an HTTP health check.
properties:
uri:
type: string
description: 'HTTP path used for the health check.
The HTTP path to use when performing a health check on backend servers.'
method:
type: string
description: 'HTTP method used for the health check.
The HTTP method used when performing a health check on backend servers.'
code:
type: integer
description: 'HTTP response code expected for a successful health check.
The HTTP response code that should be returned for a health check to be considered successful.'
format: int32
nullable: true
host_header:
type: string
description: 'HTTP host header used for the health check.
The HTTP host header used when performing a health check on backend servers.'
nullable: true
x-properties-order:
- uri
- method
- code
- host_header
x-one-of: Config
https_config:
type: object
description: Object to configure an HTTPS health check.
properties:
uri:
type: string
description: 'HTTP path used for the health check.
The HTTP path to use when performing a health check on backend servers.'
method:
type: string
description: 'HTTP method used for the health check.
The HTTP method used when performing a health check on backend servers.'
code:
type: integer
description: 'HTTP response code expected for a successful health check.
The HTTP response code that should be returned for a health check to be considered successful.'
format: int32
nullable: true
host_header:
# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/scaleway/refs/heads/main/openapi/scaleway-backends-api-openapi.yml