openapi: 3.1.0
info:
title: Managed Database for PostgreSQL and MySQL Access Control List Frontends 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: Frontends
description: The Load Balancer frontend object. It listens on a configured port and forward requests to one or several backends. You can create multiple frontends for any given Load Balancer, each listening on a different port, and choose to add certificates to them if you wish. Use the frontends endpoint to create, list, manage and delete frontends.
paths:
/lb/v1/zones/{zone}/frontends/{frontend_id}:
get:
tags:
- Frontends
operationId: GetFrontend
summary: Get a frontend
description: Get the full details of a given frontend, specified by its frontend ID. The response contains the frontend's full configuration parameters including the backend it is attached to, the port it listens on, and any certificates it has.
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: frontend_id
description: Frontend ID.
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.lb.v1.Frontend'
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}/frontends/{frontend_id}\""
- lang: HTTPie
source: "http GET \"https://api.scaleway.com/lb/v1/zones/{zone}/frontends/{frontend_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
put:
tags:
- Frontends
operationId: UpdateFrontend
summary: Update a frontend
description: Update a given frontend, specified by its frontend ID. You can update configuration parameters including its name and the port it listens on. 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: frontend_id
description: Frontend ID.
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.lb.v1.Frontend'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Frontend name.
inbound_port:
type: integer
description: Port the frontend should listen on.
format: int32
backend_id:
type: string
description: Backend ID (ID of the backend the frontend should pass traffic to).
timeout_client:
type: number
description: Maximum allowed inactivity time on the client side. (in milliseconds)
certificate_id:
type: string
description: Certificate ID, deprecated in favor of certificate_ids array.
deprecated: true
nullable: true
certificate_ids:
type: array
description: List of SSL/TLS certificate IDs to bind to the frontend.
nullable: true
items:
type: string
enable_http3:
type: boolean
description: Defines whether to enable HTTP/3 protocol on the frontend.
connection_rate_limit:
type: integer
description: Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.
format: uint32
nullable: true
enable_access_logs:
type: boolean
description: Defines whether to enable access logs on the frontend.
required:
- name
- inbound_port
- backend_id
x-properties-order:
- name
- inbound_port
- backend_id
- timeout_client
- certificate_id
- certificate_ids
- enable_http3
- connection_rate_limit
- enable_access_logs
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 \"backend_id\": \"string\",\n \"enable_http3\": false,\n \"inbound_port\": 42,\n \"name\": \"string\"\n }' \\\n \"https://api.scaleway.com/lb/v1/zones/{zone}/frontends/{frontend_id}\""
- lang: HTTPie
source: "http PUT \"https://api.scaleway.com/lb/v1/zones/{zone}/frontends/{frontend_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY \\\n backend_id=\"string\" \\\n enable_http3:=false \\\n inbound_port:=42 \\\n name=\"string\""
delete:
tags:
- Frontends
operationId: DeleteFrontend
summary: Delete a frontend
description: Delete a given frontend, specified by its frontend 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: frontend_id
description: ID of the frontend 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}/frontends/{frontend_id}\""
- lang: HTTPie
source: "http DELETE \"https://api.scaleway.com/lb/v1/zones/{zone}/frontends/{frontend_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
/lb/v1/zones/{zone}/lbs/{lb_id}/frontends:
get:
tags:
- Frontends
operationId: ListFrontends
summary: List frontends of a given Load Balancer
description: List all the frontends of a Load Balancer, specified by its Load Balancer ID. By default, results are returned in ascending order by the creation date of each frontend. The response is an array of frontend objects, containing full details of each one including the port they listen on and the backend they are attached to.
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: lb_id
description: Load Balancer ID.
required: true
schema:
type: string
- in: query
name: name
description: Name of the frontend to filter for.
schema:
type: string
- in: query
name: order_by
description: Sort order of frontends in the response.
schema:
type: string
enum:
- created_at_asc
- created_at_desc
- name_asc
- name_desc
default: created_at_asc
- in: query
name: page
description: The page number to return, from the paginated results.
schema:
type: integer
format: int32
- in: query
name: page_size
description: Number of frontends to return.
schema:
type: integer
format: uint32
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.lb.v1.ListFrontendsResponse'
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}/lbs/{lb_id}/frontends\""
- lang: HTTPie
source: "http GET \"https://api.scaleway.com/lb/v1/zones/{zone}/lbs/{lb_id}/frontends\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
post:
tags:
- Frontends
operationId: CreateFrontend
summary: Create a frontend in a given Load Balancer
description: Create a new frontend for a given Load Balancer, specifying its configuration including the port it should listen on and the backend to attach it to.
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: lb_id
description: Load Balancer ID (ID of the Load Balancer to attach the frontend to).
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.lb.v1.Frontend'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Name for the frontend.
inbound_port:
type: integer
description: Port the frontend should listen on.
format: int32
backend_id:
type: string
description: Backend ID (ID of the backend the frontend should pass traffic to).
timeout_client:
type: number
description: Maximum allowed inactivity time on the client side. (in milliseconds)
certificate_id:
type: string
description: Certificate ID, deprecated in favor of certificate_ids array.
deprecated: true
nullable: true
certificate_ids:
type: array
description: List of SSL/TLS certificate IDs to bind to the frontend.
nullable: true
items:
type: string
enable_http3:
type: boolean
description: Defines whether to enable HTTP/3 protocol on the frontend.
connection_rate_limit:
type: integer
description: Rate limit for new connections established on this frontend. Use 0 value to disable, else value is connections per second.
format: uint32
nullable: true
enable_access_logs:
type: boolean
description: Defines whether to enable access logs on the frontend.
required:
- name
- inbound_port
- backend_id
x-properties-order:
- name
- inbound_port
- backend_id
- timeout_client
- certificate_id
- certificate_ids
- enable_http3
- connection_rate_limit
- enable_access_logs
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 \"backend_id\": \"string\",\n \"enable_access_logs\": false,\n \"enable_http3\": false,\n \"inbound_port\": 42,\n \"name\": \"string\"\n }' \\\n \"https://api.scaleway.com/lb/v1/zones/{zone}/lbs/{lb_id}/frontends\""
- lang: HTTPie
source: "http POST \"https://api.scaleway.com/lb/v1/zones/{zone}/lbs/{lb_id}/frontends\" \\\n X-Auth-Token:$SCW_SECRET_KEY \\\n backend_id=\"string\" \\\n enable_access_logs:=false \\\n enable_http3:=false \\\n inbound_port:=42 \\\n name=\"string\""
components:
schemas:
scaleway.lb.v1.Ip:
type: object
properties:
id:
type: string
description: IP address ID.
ip_address:
type: string
description: IP address.
organization_id:
type: string
description: Organization ID of the Scaleway Organization the IP address is in.
project_id:
type: string
description: Project ID of the Scaleway Project the IP address is in.
lb_id:
type: string
description: Load Balancer ID.
nullable: true
reverse:
type: string
description: Reverse DNS (domain name) of the IP address.
tags:
type: array
description: IP tags.
items:
type: string
region:
type: string
description: The region the IP address is in.
deprecated: true
zone:
type: string
description: The zone the IP address is in.
x-properties-order:
- id
- ip_address
- organization_id
- project_id
- lb_id
- reverse
- tags
- region
- zone
scaleway.lb.v1.Instance:
type: object
properties:
id:
type: string
description: Underlying Instance ID.
status:
type: string
description: Instance status.
enum:
- unknown
- ready
- pending
- stopped
- error
- locked
- migrating
default: unknown
ip_address:
type: string
description: Instance IP address.
created_at:
type: string
description: Date on which the Instance was created. (RFC 3339 format)
format: date-time
example: '2022-03-22T12:34:56.123456Z'
nullable: true
updated_at:
type: string
description: Date on which the Instance was last updated. (RFC 3339 format)
format: date-time
example: '2022-03-22T12:34:56.123456Z'
nullable: true
region:
type: string
description: The region the Instance is in.
deprecated: true
zone:
type: string
description: The zone the Instance is in.
x-properties-order:
- id
- status
- ip_address
- created_at
- updated_at
- region
- zone
scaleway.lb.v1.Frontend:
type: object
properties:
id:
type: string
description: Frontend ID.
name:
type: string
description: Name of the frontend.
inbound_port:
type: integer
description: Port the frontend listens on.
format: int32
backend:
type: object
description: Backend object the frontend is attached to.
properties:
id:
type: string
description: Backend ID.
name:
type: string
description: Name of the backend.
forward_protocol:
type: string
description: Protocol used by the backend when forwarding traffic to backend servers.
enum:
- tcp
- http
default: tcp
forward_port:
type: integer
description: Port used by the backend when forwarding traffic to backend servers.
format: int32
forward_port_algorithm:
type: string
description: Load balancing algorithm to use when determining which backend server to forward new traffic to.
enum:
- roundrobin
- leastconn
- first
default: roundrobin
sticky_sessions:
type: string
description: Defines whether sticky sessions (binding a particular session t
# --- truncated at 32 KB (65 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/scaleway/refs/heads/main/openapi/scaleway-frontends-api-openapi.yml