openapi: 3.1.0
info:
title: Managed Database for PostgreSQL and MySQL Access Control List Volumes 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: Volumes
description: "A volume is where you store your data inside your Instance. It\nappears as a block device on Linux that you can use to create\na filesystem and mount it.\n\nThe Instance API only supports local (`l_ssd`) and `scratch` volume types.\nBlock storage volumes can also be attached to Instances, these volumes are\nmanaged by the SBS API (https://www.scaleway.com/en/developers/api/block/).\n\nMinimum and maximum volume sizes for each volume types can be queried\nfrom the zone `/products/volumes` API endpoint. _I.e_ for:\n - `fr-par-1` use https://api.scaleway.com/instance/v1/zones/fr-par-1/products/volumes\n - `nl-ams-1` use https://api.scaleway.com/instance/v1/zones/nl-ams-1/products/volumes\n\nEach type of volume is also subject to a global quota for the sum of all the\nvolumes. This quota depends of the level of support and may be\nchanged on demand.\n\nWhen using multiple block devices, it's advised to mount them by\nusing their UUID instead of their device name. A device name is\nsubject to change depending on the volumes order. Block devices\nUUIDs can be found in `/dev/disk/by-id/`.\n"
paths:
/instance/v1/zones/{zone}/block-migration/apply:
post:
tags:
- Volumes
operationId: ApplyBlockMigration
summary: Migrate a volume and/or snapshots to SBS (Scaleway Block Storage)
description: To be used, the call to this endpoint must be preceded by a call to the [Get a volume or snapshot's migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint. To migrate all resources mentioned in the migration plan, the validation_key returned in the plan must be provided.
parameters:
- in: path
name: zone
description: The zone you want to target
required: true
schema:
type: string
enum:
- fr-par-1
- fr-par-2
- fr-par-3
- nl-ams-1
- nl-ams-2
- nl-ams-3
- pl-waw-1
- pl-waw-2
- pl-waw-3
- it-mil-1
responses:
'204':
description: ''
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
volume_id:
type: string
description: The volume to migrate, along with potentially other resources, according to the migration plan generated with a call to the [Get a volume or snapshot's migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint.
nullable: true
x-one-of: resource
snapshot_id:
type: string
description: The snapshot to migrate, along with potentially other resources, according to the migration plan generated with a call to the [Get a volume or snapshot's migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint.
nullable: true
x-one-of: resource
validation_key:
type: string
description: A value to be retrieved from a call to the [Get a volume or snapshot's migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint, to confirm that the volume and/or snapshots specified in said plan should be migrated.
required:
- validation_key
x-properties-order:
- volume_id
- snapshot_id
- validation_key
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 '{\"validation_key\":\"string\"}' \\\n \"https://api.scaleway.com/instance/v1/zones/{zone}/block-migration/apply\""
- lang: HTTPie
source: "http POST \"https://api.scaleway.com/instance/v1/zones/{zone}/block-migration/apply\" \\\n X-Auth-Token:$SCW_SECRET_KEY \\\n validation_key=\"string\""
/instance/v1/zones/{zone}/block-migration/plan:
post:
tags:
- Volumes
operationId: PlanBlockMigration
summary: Get a volume or snapshot's migration plan
description: 'Given a volume or snapshot, returns the migration plan but does not perform the actual migration. To perform the migration, you have to call the [Migrate a volume and/or snapshots to SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage) endpoint afterward.
The endpoint returns the resources that should be migrated together:
- the volume and any snapshots created from the volume, if the call was made to plan a volume migration.
- the base volume of the snapshot (if the volume is not deleted) and its related snapshots, if the call was made to plan a snapshot migration.
The endpoint also returns the validation_key, which must be provided to the [Migrate a volume and/or snapshots to SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage) endpoint to confirm that all resources listed in the plan should be migrated.'
parameters:
- in: path
name: zone
description: The zone you want to target
required: true
schema:
type: string
enum:
- fr-par-1
- fr-par-2
- fr-par-3
- nl-ams-1
- nl-ams-2
- nl-ams-3
- pl-waw-1
- pl-waw-2
- pl-waw-3
- it-mil-1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.instance.v1.MigrationPlan'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
volume_id:
type: string
description: The volume for which the migration plan will be generated.
nullable: true
x-one-of: resource
snapshot_id:
type: string
description: The snapshot for which the migration plan will be generated.
nullable: true
x-one-of: resource
x-properties-order:
- volume_id
- snapshot_id
security:
- scaleway: []
x-codeSamples:
- lang: cURL
source: "curl -X POST \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{}' \\\n \"https://api.scaleway.com/instance/v1/zones/{zone}/block-migration/plan\""
- lang: HTTPie
source: "http POST \"https://api.scaleway.com/instance/v1/zones/{zone}/block-migration/plan\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
/instance/v1/zones/{zone}/volumes:
get:
tags:
- Volumes
operationId: ListVolumes
summary: List volumes
description: List volumes in the specified Availability Zone. You can filter the output by volume type.
parameters:
- in: path
name: zone
description: The zone you want to target
required: true
schema:
type: string
enum:
- fr-par-1
- fr-par-2
- fr-par-3
- nl-ams-1
- nl-ams-2
- nl-ams-3
- pl-waw-1
- pl-waw-2
- pl-waw-3
- it-mil-1
- in: query
name: volume_type
description: Filter by volume type.
schema:
type: string
enum:
- l_ssd
- b_ssd
- unified
- scratch
- sbs_volume
- sbs_snapshot
x-enum-descriptions:
values:
b_ssd: Deprecated
unified: Deprecated
default: l_ssd
- in: query
name: per_page
description: A positive integer lower or equal to 100 to select the number of items to return.
schema:
type: integer
format: uint32
- in: query
name: page
description: A positive integer to choose the page to return.
schema:
type: integer
format: int32
- in: query
name: organization
description: Filter volume by Organization ID.
schema:
type: string
- in: query
name: project
description: Filter volume by Project ID.
schema:
type: string
- in: query
name: tags
description: Filter volumes with these exact tags (to filter with several tags, use commas to separate them).
schema:
type: string
- in: query
name: name
description: Filter volume by name (for eg. "vol" will return "myvolume" but not "data").
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.instance.v1.ListVolumesResponse'
security:
- scaleway: []
x-codeSamples:
- lang: cURL
source: "curl -X GET \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/instance/v1/zones/{zone}/volumes\""
- lang: HTTPie
source: "http GET \"https://api.scaleway.com/instance/v1/zones/{zone}/volumes\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
post:
tags:
- Volumes
operationId: CreateVolume
summary: Create a volume
description: Create a volume of a specified type in an Availability Zone.
parameters:
- in: path
name: zone
description: The zone you want to target
required: true
schema:
type: string
enum:
- fr-par-1
- fr-par-2
- fr-par-3
- nl-ams-1
- nl-ams-2
- nl-ams-3
- pl-waw-1
- pl-waw-2
- pl-waw-3
- it-mil-1
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.instance.v1.CreateVolumeResponse'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Volume name.
organization:
type: string
description: Volume Organization ID.
deprecated: true
nullable: true
x-one-of: ProjectIdentifier
project:
type: string
description: Volume Project ID.
nullable: true
x-one-of: ProjectIdentifier
tags:
type: array
description: Volume tags.
items:
type: string
volume_type:
type: string
description: Volume type.
enum:
- l_ssd
- b_ssd
- unified
- scratch
- sbs_volume
- sbs_snapshot
x-enum-descriptions:
values:
b_ssd: Deprecated
unified: Deprecated
default: l_ssd
size:
type: integer
description: Volume disk size, must be a multiple of 512. (in bytes)
format: uint64
nullable: true
x-one-of: from
base_snapshot:
type: string
description: ID of the snapshot on which this volume will be based.
nullable: true
x-one-of: from
x-properties-order:
- name
- organization
- project
- tags
- volume_type
- size
- base_snapshot
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 '{\"name\":\"string\"}' \\\n \"https://api.scaleway.com/instance/v1/zones/{zone}/volumes\""
- lang: HTTPie
source: "http POST \"https://api.scaleway.com/instance/v1/zones/{zone}/volumes\" \\\n X-Auth-Token:$SCW_SECRET_KEY \\\n name=\"string\""
/instance/v1/zones/{zone}/volumes/{id}:
put:
tags:
- Volumes
operationId: SetVolume
summary: Update volume
description: Replace all volume properties with a volume message.
parameters:
- in: path
name: zone
description: The zone you want to target
required: true
schema:
type: string
enum:
- fr-par-1
- fr-par-2
- fr-par-3
- nl-ams-1
- nl-ams-2
- nl-ams-3
- pl-waw-1
- pl-waw-2
- pl-waw-3
- it-mil-1
- in: path
name: id
description: Unique ID of the volume.
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.instance.v1.SetVolumeResponse'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Name of the volume.
tags:
type: array
description: Tags of the volume.
nullable: true
items:
type: string
export_uri:
type: string
description: NBD export URI of the Volume (deprecated, this field is ignored).
deprecated: true
size:
type: integer
description: Volume's disk size, must be a multiple of 512. (in bytes)
format: uint64
volume_type:
type: string
description: Volume type.
enum:
- l_ssd
- b_ssd
- unified
- scratch
- sbs_volume
- sbs_snapshot
x-enum-descriptions:
values:
b_ssd: Deprecated
unified: Deprecated
default: l_ssd
creation_date:
type: string
description: Volume creation date. (RFC 3339 format)
format: date-time
example: '2022-03-22T12:34:56.123456Z'
nullable: true
modification_date:
type: string
description: Volume modification date. (RFC 3339 format)
format: date-time
example: '2022-03-22T12:34:56.123456Z'
nullable: true
organization:
type: string
description: Volume Organization ID.
project:
type: string
description: Volume Project ID.
server:
type: object
description: Instance attached to the volume.
properties:
id:
type: string
name:
type: string
x-properties-order:
- id
- name
state:
type: string
description: Volume state.
enum:
- available
- snapshotting
- fetching
- saving
- attaching
- resizing
- hotsyncing
- error
default: available
x-properties-order:
- name
- tags
- export_uri
- size
- volume_type
- creation_date
- modification_date
- organization
- project
- server
- state
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 \"export_uri\": \"string\",\n \"name\": \"string\",\n \"organization\": \"string\",\n \"project\": \"string\",\n \"size\": 42\n }' \\\n \"https://api.scaleway.com/instance/v1/zones/{zone}/volumes/{id}
# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/scaleway/refs/heads/main/openapi/scaleway-volumes-api-openapi.yml