openapi: 3.1.0
info:
title: Managed Database for PostgreSQL and MySQL Access Control List Users 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: Users
description: 'Users are profiles to which you can attribute database-level permissions. They allow you to define permissions specific to each type of database usage. For example, users with an `admin` role can create new databases and users.
'
paths:
/rdb/v1/regions/{region}/instances/{instance_id}/users:
get:
tags:
- Users
operationId: ListUsers
summary: List users of a Database Instance
description: List all users of a given Database Instance. By default, the users returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
parameters:
- in: path
name: region
description: The region you want to target
required: true
schema:
type: string
enum:
- fr-par
- nl-ams
- pl-waw
- in: path
name: instance_id
description: UUID of the Database Instance.
required: true
schema:
type: string
- in: query
name: name
description: Name of the user.
schema:
type: string
- in: query
name: order_by
description: Criteria to use when requesting user listing.
schema:
type: string
enum:
- name_asc
- name_desc
- is_admin_asc
- is_admin_desc
default: name_asc
- in: query
name: page
schema:
$ref: '#/components/schemas/google.protobuf.Int32Value'
- in: query
name: page_size
schema:
type: integer
format: uint32
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.rdb.v1.ListUsersResponse'
security:
- scaleway: []
x-codeSamples:
- lang: cURL
source: "curl -X GET \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/rdb/v1/regions/{region}/instances/{instance_id}/users\""
- lang: HTTPie
source: "http GET \"https://api.scaleway.com/rdb/v1/regions/{region}/instances/{instance_id}/users\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
post:
tags:
- Users
operationId: CreateUser
summary: Create a user for a Database Instance
description: Create a new user for a Database Instance. You must define the `name`, `password` and `is_admin` parameters.
parameters:
- in: path
name: region
description: The region you want to target
required: true
schema:
type: string
enum:
- fr-par
- nl-ams
- pl-waw
- in: path
name: instance_id
description: UUID of the Database Instance in which you want to create a user.
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.rdb.v1.User'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: Name of the user you want to create.
password:
type: string
description: Password of the user you want to create. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character.
is_admin:
type: boolean
description: Defines whether the user will have administrative privileges.
x-properties-order:
- name
- password
- is_admin
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 \"is_admin\": false,\n \"name\": \"string\",\n \"password\": \"string\"\n }' \\\n \"https://api.scaleway.com/rdb/v1/regions/{region}/instances/{instance_id}/users\""
- lang: HTTPie
source: "http POST \"https://api.scaleway.com/rdb/v1/regions/{region}/instances/{instance_id}/users\" \\\n X-Auth-Token:$SCW_SECRET_KEY \\\n is_admin:=false \\\n name=\"string\" \\\n password=\"string\""
/rdb/v1/regions/{region}/instances/{instance_id}/users/{name}:
patch:
tags:
- Users
operationId: UpdateUser
summary: Update a user on a Database Instance
description: Update the parameters of a user on a Database Instance. You can update the `password` and `is_admin` parameters, but you cannot change the name of the user.
parameters:
- in: path
name: region
description: The region you want to target
required: true
schema:
type: string
enum:
- fr-par
- nl-ams
- pl-waw
- in: path
name: instance_id
description: UUID of the Database Instance the user belongs to.
required: true
schema:
type: string
- in: path
name: name
description: Name of the database user.
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.rdb.v1.User'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
password:
type: string
description: Password of the database user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character.
nullable: true
is_admin:
type: boolean
description: Defines whether or not this user got administrative privileges.
nullable: true
x-properties-order:
- password
- is_admin
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/rdb/v1/regions/{region}/instances/{instance_id}/users/{name}\""
- lang: HTTPie
source: "http PATCH \"https://api.scaleway.com/rdb/v1/regions/{region}/instances/{instance_id}/users/{name}\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
delete:
tags:
- Users
operationId: DeleteUser
summary: Delete a user on a Database Instance
description: Delete a given user on a Database Instance. You must specify, in the endpoint, the `region`, `instance_id` and `name` parameters of the user you want to delete.
parameters:
- in: path
name: region
description: The region you want to target
required: true
schema:
type: string
enum:
- fr-par
- nl-ams
- pl-waw
- in: path
name: instance_id
description: UUID of the Database Instance to delete the user from.
required: true
schema:
type: string
- in: path
name: name
description: Name of the user.
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/rdb/v1/regions/{region}/instances/{instance_id}/users/{name}\""
- lang: HTTPie
source: "http DELETE \"https://api.scaleway.com/rdb/v1/regions/{region}/instances/{instance_id}/users/{name}\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
/iam/v1alpha1/grace-periods:
get:
tags:
- Users
operationId: ListGracePeriods
summary: List grace periods of a member
description: List the grace periods of a member.
parameters:
- in: query
name: user_id
description: ID of the user to list grace periods for.
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.iam.v1alpha1.ListGracePeriodsResponse'
security:
- scaleway: []
x-codeSamples:
- lang: cURL
source: "curl -X GET \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/iam/v1alpha1/grace-periods?user_id=string\""
- lang: HTTPie
source: "http GET \"https://api.scaleway.com/iam/v1alpha1/grace-periods\" \\\n X-Auth-Token:$SCW_SECRET_KEY \\\n user_id==string"
/iam/v1alpha1/users:
get:
tags:
- Users
operationId: ListUsers
summary: List users of an Organization
description: List the users of an Organization. By default, the users listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters for your query such as `user_ids`.
parameters:
- in: query
name: order_by
description: Criteria for sorting results.
schema:
type: string
enum:
- created_at_asc
- created_at_desc
- updated_at_asc
- updated_at_desc
- email_asc
- email_desc
- last_login_asc
- last_login_desc
- username_asc
- username_desc
x-enum-descriptions:
values:
created_at_asc: Creation date ascending
created_at_desc: Creation date descending
updated_at_asc: Update date ascending
updated_at_desc: Update date descending
email_asc: Email ascending
email_desc: Email descending
last_login_asc: Last login ascending
last_login_desc: Last login descending
username_asc: Username ascending
username_desc: Username descending
default: created_at_asc
- in: query
name: page_size
description: Number of results per page. Value must be between 1 and 100.
schema:
type: integer
format: uint32
- in: query
name: page
description: Page number. Value must be greater or equal to 1.
schema:
type: integer
format: int32
- in: query
name: organization_id
description: ID of the Organization to filter.
schema:
type: string
- in: query
name: user_ids
description: Filter by list of IDs.
schema:
type: array
items:
type: string
- in: query
name: mfa
description: Filter by MFA status.
schema:
type: boolean
- in: query
name: tag
description: Filter by tags containing a given string.
schema:
type: string
- in: query
name: type
description: Filter by user type.
schema:
type: string
enum:
- unknown_type
- owner
- member
x-enum-descriptions:
values:
unknown_type: Unknown type
owner: Owner
default: unknown_type
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.iam.v1alpha1.ListUsersResponse'
security:
- scaleway: []
x-codeSamples:
- lang: cURL
source: "curl -X GET \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/iam/v1alpha1/users?organization_id=string\""
- lang: HTTPie
source: "http GET \"https://api.scaleway.com/iam/v1alpha1/users\" \\\n X-Auth-Token:$SCW_SECRET_KEY \\\n organization_id==string"
post:
tags:
- Users
operationId: CreateUser
summary: Create a new user
description: Create a new user. You must define the `organization_id` in your request. If you are adding a member, enter the member's details. If you are adding a guest, you must define the `email` and not add the member attribute.
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.iam.v1alpha1.User'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
organization_id:
type: string
description: ID of the Organization.
email:
type: string
description: Email of the user.
nullable: true
x-one-of: type
tags:
type: array
description: Tags associated with the user.
items:
type: string
member:
type: object
description: Details of IAM member.
properties:
email:
type: string
description: Email of the user to create.
send_password_email:
type: boolean
description: Whether or not to send an email containing the member's password.
send_welcome_email:
type: boolean
description: Whether or not to send a welcome email that includes onboarding information.
username:
type: string
description: The member's username.
password:
type: string
description: The member's password.
first_name:
type: string
description: The member's first name.
last_name:
type: string
description: The member's last name.
phone_number:
type: string
description: The member's phone number.
locale:
type: string
description: The member's locale.
nullable: true
x-properties-order:
- email
- send_password_email
- send_welcome_email
- username
- password
- first_name
- last_name
- phone_number
- locale
x-one-of: type
required:
- organization_id
x-properties-order:
- organization_id
- email
- tags
- member
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 '{\"organization_id\":\"string\"}' \\\n \"https://api.scaleway.com/iam/v1alpha1/users\""
- lang: HTTPie
source: "http POST \"https://api.scaleway.com/iam/v1alpha1/users\" \\\n X-Auth-Token:$SCW_SECRET_KEY \\\n organization_id=\"string\""
/iam/v1alpha1/users/{user_id}:
get:
tags:
- Users
operationId: GetUser
summary: Get a given user
description: Retrieve information about a user, specified by the `user_id` parameter. The user's full details, including `id`, `email`, `organization_id`, `status` and `mfa` are returned in the response.
parameters:
- in: path
name: user_id
description: ID of the user to find.
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/scaleway.iam.v1alpha1.User'
security:
- scaleway: []
x-codeSamples:
- lang: cURL
source: "curl -X GET \\\n -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n \"https://api.scaleway.com/iam/v1alpha1/users/{user_id}\""
- lang: HTTPie
source: "http GET \"https://api.scaleway.com/iam/v1alpha1/users/{user_id}\" \\\n X-Auth-Token:$SCW_SECRET_KEY"
patch:
tags:
- Users
operationId: UpdateUser
summary: Update a user
description:
# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/scaleway/refs/heads/main/openapi/scaleway-users-api-openapi.yml