openapi: 3.1.0 info: title: Managed Database for PostgreSQL and MySQL Access Control List IPs 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 \n This is an optional step that seeks to simplify your usage of the APIs.\n \n\n ```bash\n export SCW_ACCESS_KEY=\"\"\n export SCW_SECRET_KEY=\"\"\n export SCW_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 \n This is a response example, the UUIDs and IP address displayed are not real.\n \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 \n In the example above, the IP and port are `198.51.100.0` and `22245`, respectively.\n \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 --port -p -u \n ```\n\n For PostgreSQL, run:\n ```bash\n psql -h -p -U -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\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\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: IPs description: 'A flexible IP address is an IP address which you hold independently of any Instance. You can attach it to any of your Instances and do live migration of the IP address between your Instances. Note that attaching a flexible IP address to an Instance removes its previous public IP and interrupts any ongoing public connection to the Instance. This does not apply if you have migrated your server to the new Network stack and have at least one flexible IP attached to the Instance. ' paths: /instance/v1/zones/{zone}/ips: get: tags: - IPs operationId: ListIps summary: List all flexible IPs description: List all flexible IPs in a specified 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 - in: query name: project description: Project ID in which the IPs are reserved. schema: type: string - in: query name: organization description: Organization ID in which the IPs are reserved. schema: type: string - in: query name: tags description: Filter IPs with these exact tags (to filter with several tags, use commas to separate them). schema: type: string - in: query name: name description: Filter on the IP address (Works as a LIKE operation on the IP address). schema: type: string - 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: type description: Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6'). schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/scaleway.instance.v1.ListIpsResponse' 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}/ips\"" - lang: HTTPie source: "http GET \"https://api.scaleway.com/instance/v1/zones/{zone}/ips\" \\\n X-Auth-Token:$SCW_SECRET_KEY" post: tags: - IPs operationId: CreateIp summary: Reserve a flexible IP description: Reserve a flexible IP and attach it to the specified Instance. 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.CreateIpResponse' requestBody: required: true content: application/json: schema: type: object properties: organization: type: string description: Organization ID in which the IP is reserved. deprecated: true nullable: true x-one-of: ProjectIdentifier project: type: string description: Project ID in which the IP is reserved. nullable: true x-one-of: ProjectIdentifier tags: type: array description: Tags of the IP. items: type: string server: type: string description: UUID of the Instance you want to attach the IP to. nullable: true type: type: string description: IP type to reserve (either 'routed_ipv4' or 'routed_ipv6'). enum: - unknown_iptype - routed_ipv4 - routed_ipv6 default: unknown_iptype x-properties-order: - organization - project - tags - server - type 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}/ips\"" - lang: HTTPie source: "http POST \"https://api.scaleway.com/instance/v1/zones/{zone}/ips\" \\\n X-Auth-Token:$SCW_SECRET_KEY" /instance/v1/zones/{zone}/ips/{ip_id}/release-to-ipam: post: tags: - IPs operationId: ReleaseIpToIpam summary: Releases the reserved IP without deleting the reservation. description: '**The IP remains available in IPAM**, which means that it is still reserved by the Organization, and can be reattached to another resource (Instance or other product).' 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: ip_id description: ID of the IP you want to release from the Instance but retain in IPAM. required: true schema: type: string responses: '204': description: '' 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/instance/v1/zones/{zone}/ips/{ip_id}/release-to-ipam\"" - lang: HTTPie source: "http POST \"https://api.scaleway.com/instance/v1/zones/{zone}/ips/{ip_id}/release-to-ipam\" \\\n X-Auth-Token:$SCW_SECRET_KEY" /instance/v1/zones/{zone}/ips/{ip}: get: tags: - IPs operationId: GetIp summary: Get a flexible IP description: Get details of an IP with the specified ID or address. 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: ip description: IP ID or address to get. required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/scaleway.instance.v1.GetIpResponse' 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}/ips/{ip}\"" - lang: HTTPie source: "http GET \"https://api.scaleway.com/instance/v1/zones/{zone}/ips/{ip}\" \\\n X-Auth-Token:$SCW_SECRET_KEY" patch: tags: - IPs operationId: UpdateIp summary: Update a flexible IP description: Update a flexible IP in the specified zone with the specified ID. 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: ip description: IP ID or IP address. required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/scaleway.instance.v1.UpdateIpResponse' requestBody: required: true content: application/json: schema: type: object properties: reverse: type: string description: Reverse domain name. nullable: true type: type: string description: Should have no effect. enum: - unknown_iptype - routed_ipv4 - routed_ipv6 default: unknown_iptype tags: type: array description: An array of keywords you want to tag this IP with. nullable: true items: type: string server: $ref: '#/components/schemas/scaleway.instance.v1.NullableStringValue' x-properties-order: - reverse - type - tags - server 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/instance/v1/zones/{zone}/ips/{ip}\"" - lang: HTTPie source: "http PATCH \"https://api.scaleway.com/instance/v1/zones/{zone}/ips/{ip}\" \\\n X-Auth-Token:$SCW_SECRET_KEY" delete: tags: - IPs operationId: DeleteIp summary: Delete a flexible IP description: Delete the IP with the specified ID. 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: ip description: ID or address of the IP 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/instance/v1/zones/{zone}/ips/{ip}\"" - lang: HTTPie source: "http DELETE \"https://api.scaleway.com/instance/v1/zones/{zone}/ips/{ip}\" \\\n X-Auth-Token:$SCW_SECRET_KEY" components: schemas: scaleway.instance.v1.ServerSummary: type: object properties: id: type: string name: type: string x-properties-order: - id - name google.protobuf.StringValue: type: string nullable: true scaleway.instance.v1.ListIpsResponse: type: object properties: ips: type: array description: List of ips. items: $ref: '#/components/schemas/scaleway.instance.v1.Ip' x-properties-order: - ips scaleway.instance.v1.UpdateIpResponse: type: object properties: ip: $ref: '#/components/schemas/scaleway.instance.v1.Ip' x-properties-order: - ip scaleway.instance.v1.CreateIpResponse: type: object properties: ip: $ref: '#/components/schemas/scaleway.instance.v1.Ip' x-properties-order: - ip scaleway.instance.v1.GetIpResponse: type: object properties: ip: $ref: '#/components/schemas/scaleway.instance.v1.Ip' x-properties-order: - ip scaleway.instance.v1.Ip: type: object properties: id: type: string address: type: string description: (IP address) example: 1.2.3.4 reverse: $ref: '#/components/schemas/google.protobuf.StringValue' server: $ref: '#/components/schemas/scaleway.instance.v1.ServerSummary' organization: type: string tags: type: array items: type: string project: type: string type: $ref: '#/components/schemas/scaleway.instance.v1.IpType' state: $ref: '#/components/schemas/scaleway.instance.v1.Ip.State' prefix: type: string description: (IP network) example: 1.2.3.4/32 ipam_id: type: string description: (UUID format) example: 6170692e-7363-616c-6577-61792e636f6d zone: type: string description: The zone you want to target x-properties-order: - id - address - reverse - server - organization - tags - project - type - state - prefix - ipam_id - zone scaleway.instance.v1.IpType: type: string enum: - unknown_iptype - routed_ipv4 - routed_ipv6 default: unknown_iptype scaleway.instance.v1.NullableStringValue: type: string nullable: true scaleway.instance.v1.Ip.State: type: string enum: - unknown_state - detached - attached - pending - error default: unknown_state securitySchemes: scaleway: in: header name: X-Auth-Token type: apiKey