{ "info": { "_postman_id": "8b9898cd-d0e5-4aa7-bdbc-07364c8da7b6", "name": "Managed Database for PostgreSQL and MySQL Access Control List Database Instances 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/).", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "lastUpdatedBy": "35240", "uid": "35240-8b9898cd-d0e5-4aa7-bdbc-07364c8da7b6" }, "item": [ { "name": "rdb", "item": [ { "name": "v1", "item": [ { "name": "regions", "item": [ { "name": "{region}", "item": [ { "name": "instances", "item": [ { "name": "{instance_id}", "item": [ { "name": "apply-maintenance", "item": [ { "name": "Apply Database Instance maintenance", "id": "973119a5-4862-4693-a8cd-f65169ace5d2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/apply-maintenance", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "apply-maintenance" ], "variable": [ { "id": "d7506417-4877-427e-967e-bf5a963107ec", "key": "region", "value": "fr-par", "description": "(Required) The region you want to target" }, { "id": "b3128302-145a-4137-9f0a-948092ac6d44", "key": "instance_id", "value": "", "description": "(Required) UUID of the Database Instance you want to apply maintenance." } ] }, "description": "Apply maintenance tasks to your Database Instance. This will trigger pending maintenance tasks to start in your Database Instance and can generate service interruption. Maintenance tasks can be applied between `starts_at` and `stops_at` times, and are run directly by Scaleway at `forced_at` timestamp." }, "response": [ { "id": "17f655a3-0ac4-4882-9ee7-561b9fb0fae4", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/apply-maintenance", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "apply-maintenance" ], "variable": [ { "key": "region" }, { "key": "instance_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"starts_at\": \"\",\n \"stops_at\": \"\",\n \"closed_at\": \"\",\n \"reason\": \"\",\n \"status\": \"unknown\",\n \"forced_at\": \"\",\n \"is_applicable\": \"\"\n}", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-17f655a3-0ac4-4882-9ee7-561b9fb0fae4" } ], "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-973119a5-4862-4693-a8cd-f65169ace5d2" } ], "id": "d9bcfac6-7f72-48f3-90c0-2968284272fb", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-d9bcfac6-7f72-48f3-90c0-2968284272fb" }, { "name": "certificate", "item": [ { "name": "Get the TLS certificate of a Database Instance", "id": "adc5a8ec-5011-44e5-bd9a-288d06044c27", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/certificate", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "certificate" ], "variable": [ { "id": "b2103633-4648-40ba-91a7-a6bce91b943e", "key": "region", "value": "fr-par", "description": "(Required) The region you want to target" }, { "id": "5d550df8-b999-483c-ad9c-185c0c31abf3", "key": "instance_id", "value": "", "description": "(Required) UUID of the Database Instance." } ] }, "description": "Retrieve information about the TLS certificate of a given Database Instance. Details like name and content are returned in the response." }, "response": [ { "id": "e24d9da6-09ca-4bd6-850d-1731e47e7e48", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/certificate", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "certificate" ], "variable": [ { "key": "region" }, { "key": "instance_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"content_type\": \"\",\n \"content\": \"\"\n}", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-e24d9da6-09ca-4bd6-850d-1731e47e7e48" } ], "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-adc5a8ec-5011-44e5-bd9a-288d06044c27" } ], "id": "b2301cf6-fd77-4c32-9c38-417a9cb6ebd6", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-b2301cf6-fd77-4c32-9c38-417a9cb6ebd6" }, { "name": "clone", "item": [ { "name": "Clone a Database Instance", "id": "d57a6222-29b2-4919-93f1-9a1a10415825", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"node_type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/clone", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "clone" ], "variable": [ { "id": "b64f2c2e-b995-4e37-92c1-082327cfc2f6", "key": "region", "value": "fr-par", "description": "(Required) The region you want to target" }, { "id": "aa7d5cca-12d4-4a4c-89c9-4e9a5c484a42", "key": "instance_id", "value": "", "description": "(Required) UUID of the Database Instance you want to clone." } ] }, "description": "Clone a given Database Instance, specified by the `region` and `instance_id` parameters. The clone feature allows you to create a new Database Instance from an existing one. The clone includes all existing databases, users and permissions. You can create a clone on a Database Instance bigger than your current one." }, "response": [ { "id": "f4cb4e5b-3178-4b02-b71f-5a3e3a4e3356", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"node_type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/clone", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "clone" ], "variable": [ { "key": "region" }, { "key": "instance_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"created_at\": \"\",\n \"volume\": {\n \"type\": \"lssd\",\n \"size\": \"\",\n \"class\": \"unknown_storage_class\"\n },\n \"region\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"project_id\": \"\",\n \"status\": \"unknown\",\n \"engine\": \"\",\n \"upgradable_version\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"minor_version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"minor_version\": \"\"\n }\n ],\n \"endpoint\": {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"settings\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"backup_schedule\": {\n \"frequency\": \"\",\n \"retention\": \"\",\n \"disabled\": \"\",\n \"next_run_at\": \"\"\n },\n \"is_ha_cluster\": \"\",\n \"read_replicas\": [\n {\n \"id\": \"\",\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"status\": \"unknown\",\n \"region\": \"\",\n \"same_zone\": \"\",\n \"instance_id\": \"\"\n },\n {\n \"id\": \"\",\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"status\": \"unknown\",\n \"region\": \"\",\n \"same_zone\": \"\",\n \"instance_id\": \"\"\n }\n ],\n \"node_type\": \"\",\n \"init_settings\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"logs_policy\": {\n \"max_age_retention\": \"\",\n \"total_disk_retention\": \"\"\n },\n \"backup_same_region\": \"\",\n \"maintenances\": [\n {\n \"starts_at\": \"\",\n \"stops_at\": \"\",\n \"closed_at\": \"\",\n \"reason\": \"\",\n \"status\": \"unknown\",\n \"forced_at\": \"\",\n \"is_applicable\": \"\"\n },\n {\n \"starts_at\": \"\",\n \"stops_at\": \"\",\n \"closed_at\": \"\",\n \"reason\": \"\",\n \"status\": \"unknown\",\n \"forced_at\": \"\",\n \"is_applicable\": \"\"\n }\n ],\n \"encryption\": {\n \"enabled\": \"\"\n }\n}", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-f4cb4e5b-3178-4b02-b71f-5a3e3a4e3356" } ], "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-d57a6222-29b2-4919-93f1-9a1a10415825" } ], "id": "48b8a819-9d26-4221-b053-022376679e79", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-48b8a819-9d26-4221-b053-022376679e79" }, { "name": "logs", "item": [ { "name": "List available logs of a Database Instance", "id": "bc9503f7-12db-4ce6-ace8-f61031200588", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/logs?order_by=created_at_asc", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "logs" ], "query": [ { "description": "Criteria to use when ordering Database Instance logs listing.", "key": "order_by", "value": "created_at_asc" } ], "variable": [ { "id": "d73546d6-f2fa-4b9b-a321-72162904968a", "key": "region", "value": "fr-par", "description": "(Required) The region you want to target" }, { "id": "8a75c54c-c65d-435c-8bfc-8b60963e3612", "key": "instance_id", "value": "", "description": "(Required) UUID of the Database Instance you want logs of." } ] }, "description": "List the available logs of a Database Instance. By default, the logs returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field." }, "response": [ { "id": "e8f5649a-0219-4b23-9d6b-fa797dba2f28", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/logs?order_by=created_at_asc", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "logs" ], "query": [ { "description": "Criteria to use when ordering Database Instance logs listing.", "key": "order_by", "value": "created_at_asc" } ], "variable": [ { "key": "region" }, { "key": "instance_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"instance_logs\": [\n {\n \"download_url\": \"\",\n \"id\": \"\",\n \"status\": \"unknown\",\n \"node_name\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"region\": \"\"\n },\n {\n \"download_url\": \"\",\n \"id\": \"\",\n \"status\": \"unknown\",\n \"node_name\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"region\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-e8f5649a-0219-4b23-9d6b-fa797dba2f28" } ], "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-bc9503f7-12db-4ce6-ace8-f61031200588" } ], "id": "558a2de3-7119-4586-8551-f7be4a4a0940", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-558a2de3-7119-4586-8551-f7be4a4a0940" }, { "name": "logs-details", "item": [ { "name": "List remote Database Instance logs details", "id": "db5e5037-b9a5-4f47-ba66-c15d016c47d1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/logs-details", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "logs-details" ], "variable": [ { "id": "82f2adba-bcf4-47c9-9e5b-088f376a640e", "key": "region", "value": "fr-par", "description": "(Required) The region you want to target" }, { "id": "12459a20-8ef8-4665-9106-76ac4e915653", "key": "instance_id", "value": "", "description": "(Required) UUID of the Database Instance you want logs of." } ] }, "description": "List remote log details. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field." }, "response": [ { "id": "8299295e-78bb-462b-b706-f15876e89f1c", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/logs-details", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "logs-details" ], "variable": [ { "key": "region" }, { "key": "instance_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"details\": [\n {\n \"log_name\": \"\",\n \"size\": \"\"\n },\n {\n \"log_name\": \"\",\n \"size\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-8299295e-78bb-462b-b706-f15876e89f1c" } ], "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-db5e5037-b9a5-4f47-ba66-c15d016c47d1" } ], "id": "198d59fb-8c18-480e-99b9-b44f3a818681", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-198d59fb-8c18-480e-99b9-b44f3a818681" }, { "name": "metrics", "item": [ { "name": "[deprecated] Get Database Instance metrics", "id": "ab25963e-8bbd-4e98-94da-0df8b9d351dd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/metrics?start_date=&end_date=&metric_name=", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "metrics" ], "query": [ { "description": "Start date to gather metrics from. (RFC 3339 format)", "key": "start_date", "value": "" }, { "description": "End date to gather metrics from. (RFC 3339 format)", "key": "end_date", "value": "" }, { "description": "Name of the metric to gather.", "key": "metric_name", "value": "" } ], "variable": [ { "id": "be3e5394-a4da-4027-94b6-946cbd8963fd", "key": "region", "value": "fr-par", "description": "(Required) The region you want to target" }, { "id": "2cef7fa7-dbbb-4e40-a786-3bbbbc9c2db4", "key": "instance_id", "value": "", "description": "(Required) UUID of the Database Instance." } ] }, "description": "Retrieve the time series metrics of a given Database Instance. You can define the period from which to retrieve metrics by specifying the `start_date` and `end_date`. This method is deprecated and will be removed in a future version." }, "response": [ { "id": "17126a12-f8ad-40b9-8942-8560e64b7985", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/metrics?start_date=&end_date=&metric_name=", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "metrics" ], "query": [ { "description": "Start date to gather metrics from. (RFC 3339 format)", "key": "start_date", "value": "" }, { "description": "End date to gather metrics from. (RFC 3339 format)", "key": "end_date", "value": "" }, { "description": "Name of the metric to gather.", "key": "metric_name", "value": "" } ], "variable": [ { "key": "region" }, { "key": "instance_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"timeseries\": [\n {\n \"name\": \"\",\n \"points\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"metadata\": {\n \"\": \"\",\n \"amet_54\": \"commodo magna ad\"\n }\n },\n {\n \"name\": \"\",\n \"points\": [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n \"metadata\": {\n \"\": \"\",\n \"ad_c\": 79238721.7382316,\n \"in_6e4\": \"irure enim\",\n \"ipsum_73\": \"aute dolore magna\",\n \"commodo49d\": \"non in aliqua sit\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-17126a12-f8ad-40b9-8942-8560e64b7985" } ], "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-ab25963e-8bbd-4e98-94da-0df8b9d351dd" } ], "id": "e88e937d-5249-489c-b584-bb5428b923f0", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-e88e937d-5249-489c-b584-bb5428b923f0" }, { "name": "prepare-logs", "item": [ { "name": "Prepare logs of a Database Instance", "id": "9bf61cb6-7601-4ce0-8110-b4868dc1f65f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/prepare-logs", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "prepare-logs" ], "variable": [ { "id": "aa43c2db-8c6e-4c35-91a4-67b2fcfbb64f", "key": "region", "value": "fr-par", "description": "(Required) The region you want to target" }, { "id": "dcae8d5d-9063-42ad-a40b-060e005c3cdb", "key": "instance_id", "value": "", "description": "(Required) UUID of the Database Instance you want logs of." } ] }, "description": "Prepare your Database Instance logs. You can define the `start_date` and `end_date` parameters for your query. The download URL is returned in the response. Logs are recorded from 00h00 to 23h59 and then aggregated in a `.log` file once a day. Therefore, even if you specify a timeframe from which you want to get the logs, you will receive logs from the full 24 hours." }, "response": [ { "id": "fc0bb790-24a0-40e3-bdb2-281a10477706", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/prepare-logs", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "prepare-logs" ], "variable": [ { "key": "region" }, { "key": "instance_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"instance_logs\": [\n {\n \"download_url\": \"\",\n \"id\": \"\",\n \"status\": \"unknown\",\n \"node_name\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"region\": \"\"\n },\n {\n \"download_url\": \"\",\n \"id\": \"\",\n \"status\": \"unknown\",\n \"node_name\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"region\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-fc0bb790-24a0-40e3-bdb2-281a10477706" } ], "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-9bf61cb6-7601-4ce0-8110-b4868dc1f65f" } ], "id": "0fc0a3af-1776-4488-ad53-cd5a26b53467", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-0fc0a3af-1776-4488-ad53-cd5a26b53467" }, { "name": "purge-logs", "item": [ { "name": "Purge remote Database Instance logs", "id": "303893ef-0b83-44fb-9920-2d5235f90896", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"log_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/purge-logs", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "purge-logs" ], "variable": [ { "id": "3e74e97d-6a2d-42a6-8afb-f26c8889cfdb", "key": "region", "value": "fr-par", "description": "(Required) The region you want to target" }, { "id": "a480fac2-ed2a-49ba-8827-59fd42a5c7ea", "key": "instance_id", "value": "", "description": "(Required) UUID of the Database Instance you want logs of." } ] }, "description": "Purge a given remote log from a Database Instance. You can specify the `log_name` of the log you wish to clean from your Database Instance." }, "response": [ { "id": "69d4acf2-3304-4f78-979d-657728854be7", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"log_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/purge-logs", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "purge-logs" ], "variable": [ { "key": "region" }, { "key": "instance_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-69d4acf2-3304-4f78-979d-657728854be7" } ], "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-303893ef-0b83-44fb-9920-2d5235f90896" } ], "id": "9848001b-676c-4ada-9937-6ead8087f9c2", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-9848001b-676c-4ada-9937-6ead8087f9c2" }, { "name": "renew-certificate", "item": [ { "name": "Renew the TLS certificate of a Database Instance", "id": "b98e402b-28bc-4e04-bb3f-6db4644e9fd9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/renew-certificate", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "renew-certificate" ], "variable": [ { "id": "b50c8506-b9b0-45eb-a803-664bab03a947", "key": "region", "value": "fr-par", "description": "(Required) The region you want to target" }, { "id": "4bf6b284-940d-48a8-872e-1c716a817e8c", "key": "instance_id", "value": "", "description": "(Required) UUID of the Database Instance you want logs of." } ] }, "description": "Renew a TLS for a Database Instance. Renewing a certificate means that you will not be able to connect to your Database Instance using the previous certificate. You will also need to download and update the new certificate for all database clients." }, "response": [ { "id": "dac99d22-d224-4d37-b23b-cd66ca1a0e16", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/renew-certificate", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "renew-certificate" ], "variable": [ { "key": "region" }, { "key": "instance_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-dac99d22-d224-4d37-b23b-cd66ca1a0e16" } ], "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-b98e402b-28bc-4e04-bb3f-6db4644e9fd9" } ], "id": "a47d01a2-be1d-492f-aeb1-d40eb306e120", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-a47d01a2-be1d-492f-aeb1-d40eb306e120" }, { "name": "restart", "item": [ { "name": "Restart Database Instance", "id": "6fbb2f36-092d-4690-9b4f-7929bb8b4288", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/restart", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "restart" ], "variable": [ { "id": "ab868156-b3ee-4e0f-9ef6-84df43f1c214", "key": "region", "value": "fr-par", "description": "(Required) The region you want to target" }, { "id": "0af6ec34-ef1d-44e2-b759-e8bcff294b4a", "key": "instance_id", "value": "", "description": "(Required) UUID of the Database Instance you want to restart." } ] }, "description": "Restart a given Database Instance, specified by the `region` and `instance_id` parameters. The status of the Database Instance returned in the response." }, "response": [ { "id": "4d656041-e7a4-4b01-be8c-c75e84b1486d", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/restart", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "restart" ], "variable": [ { "key": "region" }, { "key": "instance_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"created_at\": \"\",\n \"volume\": {\n \"type\": \"lssd\",\n \"size\": \"\",\n \"class\": \"unknown_storage_class\"\n },\n \"region\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"project_id\": \"\",\n \"status\": \"unknown\",\n \"engine\": \"\",\n \"upgradable_version\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"minor_version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"minor_version\": \"\"\n }\n ],\n \"endpoint\": {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"settings\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"backup_schedule\": {\n \"frequency\": \"\",\n \"retention\": \"\",\n \"disabled\": \"\",\n \"next_run_at\": \"\"\n },\n \"is_ha_cluster\": \"\",\n \"read_replicas\": [\n {\n \"id\": \"\",\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"status\": \"unknown\",\n \"region\": \"\",\n \"same_zone\": \"\",\n \"instance_id\": \"\"\n },\n {\n \"id\": \"\",\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"status\": \"unknown\",\n \"region\": \"\",\n \"same_zone\": \"\",\n \"instance_id\": \"\"\n }\n ],\n \"node_type\": \"\",\n \"init_settings\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"logs_policy\": {\n \"max_age_retention\": \"\",\n \"total_disk_retention\": \"\"\n },\n \"backup_same_region\": \"\",\n \"maintenances\": [\n {\n \"starts_at\": \"\",\n \"stops_at\": \"\",\n \"closed_at\": \"\",\n \"reason\": \"\",\n \"status\": \"unknown\",\n \"forced_at\": \"\",\n \"is_applicable\": \"\"\n },\n {\n \"starts_at\": \"\",\n \"stops_at\": \"\",\n \"closed_at\": \"\",\n \"reason\": \"\",\n \"status\": \"unknown\",\n \"forced_at\": \"\",\n \"is_applicable\": \"\"\n }\n ],\n \"encryption\": {\n \"enabled\": \"\"\n }\n}", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-4d656041-e7a4-4b01-be8c-c75e84b1486d" } ], "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-6fbb2f36-092d-4690-9b4f-7929bb8b4288" } ], "id": "7bf0584a-75c0-4f20-8fa9-62c34f96855c", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-7bf0584a-75c0-4f20-8fa9-62c34f96855c" }, { "name": "upgrade", "item": [ { "name": "Upgrade a Database Instance", "id": "6d52b5a6-a946-45e6-83b8-4ed5fa5b95b5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"node_type\": \"\",\n \"enable_ha\": \"\",\n \"volume_size\": \"\",\n \"volume_type\": \"lssd\",\n \"upgradable_version_id\": \"\",\n \"major_upgrade_workflow\": {\n \"upgradable_version_id\": \"\",\n \"with_endpoints\": \"\"\n },\n \"enable_encryption\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/upgrade", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "upgrade" ], "variable": [ { "id": "99906609-b57b-4432-bee2-34a8f4345183", "key": "region", "value": "fr-par", "description": "(Required) The region you want to target" }, { "id": "f0939dbc-9930-47df-8751-14f38fb195ae", "key": "instance_id", "value": "", "description": "(Required) UUID of the Database Instance you want to upgrade." } ] }, "description": "Upgrade your current Database Instance specifications like node type, high availability, volume, or the database engine version. Note that upon upgrade the `enable_ha` parameter can only be set to `true`." }, "response": [ { "id": "f64799e0-d30c-40f3-bd3f-db1aa3773f74", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"node_type\": \"\",\n \"enable_ha\": \"\",\n \"volume_size\": \"\",\n \"volume_type\": \"lssd\",\n \"upgradable_version_id\": \"\",\n \"major_upgrade_workflow\": {\n \"upgradable_version_id\": \"\",\n \"with_endpoints\": \"\"\n },\n \"enable_encryption\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id/upgrade", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id", "upgrade" ], "variable": [ { "key": "region" }, { "key": "instance_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"created_at\": \"\",\n \"volume\": {\n \"type\": \"lssd\",\n \"size\": \"\",\n \"class\": \"unknown_storage_class\"\n },\n \"region\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"project_id\": \"\",\n \"status\": \"unknown\",\n \"engine\": \"\",\n \"upgradable_version\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"minor_version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"minor_version\": \"\"\n }\n ],\n \"endpoint\": {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"settings\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"backup_schedule\": {\n \"frequency\": \"\",\n \"retention\": \"\",\n \"disabled\": \"\",\n \"next_run_at\": \"\"\n },\n \"is_ha_cluster\": \"\",\n \"read_replicas\": [\n {\n \"id\": \"\",\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"status\": \"unknown\",\n \"region\": \"\",\n \"same_zone\": \"\",\n \"instance_id\": \"\"\n },\n {\n \"id\": \"\",\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"status\": \"unknown\",\n \"region\": \"\",\n \"same_zone\": \"\",\n \"instance_id\": \"\"\n }\n ],\n \"node_type\": \"\",\n \"init_settings\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"logs_policy\": {\n \"max_age_retention\": \"\",\n \"total_disk_retention\": \"\"\n },\n \"backup_same_region\": \"\",\n \"maintenances\": [\n {\n \"starts_at\": \"\",\n \"stops_at\": \"\",\n \"closed_at\": \"\",\n \"reason\": \"\",\n \"status\": \"unknown\",\n \"forced_at\": \"\",\n \"is_applicable\": \"\"\n },\n {\n \"starts_at\": \"\",\n \"stops_at\": \"\",\n \"closed_at\": \"\",\n \"reason\": \"\",\n \"status\": \"unknown\",\n \"forced_at\": \"\",\n \"is_applicable\": \"\"\n }\n ],\n \"encryption\": {\n \"enabled\": \"\"\n }\n}", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-f64799e0-d30c-40f3-bd3f-db1aa3773f74" } ], "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-6d52b5a6-a946-45e6-83b8-4ed5fa5b95b5" } ], "id": "fa39112f-0180-4e8b-832c-48d78313f3ad", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-fa39112f-0180-4e8b-832c-48d78313f3ad" }, { "name": "Get a Database Instance", "id": "33f4a299-13c8-4bde-9e65-f7820cc34796", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id" ], "variable": [ { "id": "e970bc3f-5f5d-440f-ab14-690b6e9be21b", "key": "region", "value": "fr-par", "description": "(Required) The region you want to target" }, { "id": "2e033998-65ec-4ee8-9731-4393849eb94d", "key": "instance_id", "value": "", "description": "(Required) UUID of the Database Instance." } ] }, "description": "Retrieve information about a given Database Instance, specified by the `region` and `instance_id` parameters. Its full details, including name, status, IP address and port, are returned in the response object." }, "response": [ { "id": "c0d3729e-26d0-47ef-95d8-2c64ee62079c", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id" ], "variable": [ { "key": "region" }, { "key": "instance_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"created_at\": \"\",\n \"volume\": {\n \"type\": \"lssd\",\n \"size\": \"\",\n \"class\": \"unknown_storage_class\"\n },\n \"region\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"project_id\": \"\",\n \"status\": \"unknown\",\n \"engine\": \"\",\n \"upgradable_version\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"minor_version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"minor_version\": \"\"\n }\n ],\n \"endpoint\": {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"settings\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"backup_schedule\": {\n \"frequency\": \"\",\n \"retention\": \"\",\n \"disabled\": \"\",\n \"next_run_at\": \"\"\n },\n \"is_ha_cluster\": \"\",\n \"read_replicas\": [\n {\n \"id\": \"\",\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"status\": \"unknown\",\n \"region\": \"\",\n \"same_zone\": \"\",\n \"instance_id\": \"\"\n },\n {\n \"id\": \"\",\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"status\": \"unknown\",\n \"region\": \"\",\n \"same_zone\": \"\",\n \"instance_id\": \"\"\n }\n ],\n \"node_type\": \"\",\n \"init_settings\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"logs_policy\": {\n \"max_age_retention\": \"\",\n \"total_disk_retention\": \"\"\n },\n \"backup_same_region\": \"\",\n \"maintenances\": [\n {\n \"starts_at\": \"\",\n \"stops_at\": \"\",\n \"closed_at\": \"\",\n \"reason\": \"\",\n \"status\": \"unknown\",\n \"forced_at\": \"\",\n \"is_applicable\": \"\"\n },\n {\n \"starts_at\": \"\",\n \"stops_at\": \"\",\n \"closed_at\": \"\",\n \"reason\": \"\",\n \"status\": \"unknown\",\n \"forced_at\": \"\",\n \"is_applicable\": \"\"\n }\n ],\n \"encryption\": {\n \"enabled\": \"\"\n }\n}", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-c0d3729e-26d0-47ef-95d8-2c64ee62079c" } ], "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-33f4a299-13c8-4bde-9e65-f7820cc34796" }, { "name": "Update a Database Instance", "id": "92ec06cd-0861-4d77-9a88-26cd074e60c1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"backup_schedule_frequency\": \"\",\n \"backup_schedule_retention\": \"\",\n \"is_backup_schedule_disabled\": \"\",\n \"name\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"logs_policy\": {\n \"max_age_retention\": \"\",\n \"total_disk_retention\": \"\"\n },\n \"backup_same_region\": \"\",\n \"backup_schedule_start_hour\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id" ], "variable": [ { "id": "4c71f57c-f28e-479c-a30a-847ec098ccd3", "key": "region", "value": "fr-par", "description": "(Required) The region you want to target" }, { "id": "8f3cae9d-f7b6-4c05-94bf-0e2a983c0e28", "key": "instance_id", "value": "", "description": "(Required) UUID of the Database Instance to update." } ] }, "description": "Update the parameters of a Database Instance, including name, tags and backup schedule details." }, "response": [ { "id": "4c2c3efc-3e62-4acf-b93d-bd443f5b2280", "name": "New Response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"backup_schedule_frequency\": \"\",\n \"backup_schedule_retention\": \"\",\n \"is_backup_schedule_disabled\": \"\",\n \"name\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"logs_policy\": {\n \"max_age_retention\": \"\",\n \"total_disk_retention\": \"\"\n },\n \"backup_same_region\": \"\",\n \"backup_schedule_start_hour\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id" ], "variable": [ { "key": "region" }, { "key": "instance_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"created_at\": \"\",\n \"volume\": {\n \"type\": \"lssd\",\n \"size\": \"\",\n \"class\": \"unknown_storage_class\"\n },\n \"region\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"project_id\": \"\",\n \"status\": \"unknown\",\n \"engine\": \"\",\n \"upgradable_version\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"minor_version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"minor_version\": \"\"\n }\n ],\n \"endpoint\": {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"settings\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"backup_schedule\": {\n \"frequency\": \"\",\n \"retention\": \"\",\n \"disabled\": \"\",\n \"next_run_at\": \"\"\n },\n \"is_ha_cluster\": \"\",\n \"read_replicas\": [\n {\n \"id\": \"\",\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"status\": \"unknown\",\n \"region\": \"\",\n \"same_zone\": \"\",\n \"instance_id\": \"\"\n },\n {\n \"id\": \"\",\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"status\": \"unknown\",\n \"region\": \"\",\n \"same_zone\": \"\",\n \"instance_id\": \"\"\n }\n ],\n \"node_type\": \"\",\n \"init_settings\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"logs_policy\": {\n \"max_age_retention\": \"\",\n \"total_disk_retention\": \"\"\n },\n \"backup_same_region\": \"\",\n \"maintenances\": [\n {\n \"starts_at\": \"\",\n \"stops_at\": \"\",\n \"closed_at\": \"\",\n \"reason\": \"\",\n \"status\": \"unknown\",\n \"forced_at\": \"\",\n \"is_applicable\": \"\"\n },\n {\n \"starts_at\": \"\",\n \"stops_at\": \"\",\n \"closed_at\": \"\",\n \"reason\": \"\",\n \"status\": \"unknown\",\n \"forced_at\": \"\",\n \"is_applicable\": \"\"\n }\n ],\n \"encryption\": {\n \"enabled\": \"\"\n }\n}", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-4c2c3efc-3e62-4acf-b93d-bd443f5b2280" } ], "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-92ec06cd-0861-4d77-9a88-26cd074e60c1" }, { "name": "Delete a Database Instance", "id": "ad319b00-d3fc-4f20-8617-a4da8a1d39ec", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id" ], "variable": [ { "id": "8c7dcf03-d810-4c98-afca-9f623184e928", "key": "region", "value": "fr-par", "description": "(Required) The region you want to target" }, { "id": "c19a16fb-cb43-46c0-8f5e-8e91aa8b576b", "key": "instance_id", "value": "", "description": "(Required) UUID of the Database Instance to delete." } ] }, "description": "Delete a given Database Instance, specified by the `region` and `instance_id` parameters. Deleting a Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost." }, "response": [ { "id": "b28e4aa0-c96c-4ec2-a34a-95d816bc3df9", "name": "New Response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances/:instance_id", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances", ":instance_id" ], "variable": [ { "key": "region" }, { "key": "instance_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"created_at\": \"\",\n \"volume\": {\n \"type\": \"lssd\",\n \"size\": \"\",\n \"class\": \"unknown_storage_class\"\n },\n \"region\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"project_id\": \"\",\n \"status\": \"unknown\",\n \"engine\": \"\",\n \"upgradable_version\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"minor_version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"minor_version\": \"\"\n }\n ],\n \"endpoint\": {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"settings\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"backup_schedule\": {\n \"frequency\": \"\",\n \"retention\": \"\",\n \"disabled\": \"\",\n \"next_run_at\": \"\"\n },\n \"is_ha_cluster\": \"\",\n \"read_replicas\": [\n {\n \"id\": \"\",\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"status\": \"unknown\",\n \"region\": \"\",\n \"same_zone\": \"\",\n \"instance_id\": \"\"\n },\n {\n \"id\": \"\",\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"status\": \"unknown\",\n \"region\": \"\",\n \"same_zone\": \"\",\n \"instance_id\": \"\"\n }\n ],\n \"node_type\": \"\",\n \"init_settings\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"logs_policy\": {\n \"max_age_retention\": \"\",\n \"total_disk_retention\": \"\"\n },\n \"backup_same_region\": \"\",\n \"maintenances\": [\n {\n \"starts_at\": \"\",\n \"stops_at\": \"\",\n \"closed_at\": \"\",\n \"reason\": \"\",\n \"status\": \"unknown\",\n \"forced_at\": \"\",\n \"is_applicable\": \"\"\n },\n {\n \"starts_at\": \"\",\n \"stops_at\": \"\",\n \"closed_at\": \"\",\n \"reason\": \"\",\n \"status\": \"unknown\",\n \"forced_at\": \"\",\n \"is_applicable\": \"\"\n }\n ],\n \"encryption\": {\n \"enabled\": \"\"\n }\n}", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-b28e4aa0-c96c-4ec2-a34a-95d816bc3df9" } ], "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-ad319b00-d3fc-4f20-8617-a4da8a1d39ec" } ], "id": "788eee61-2b50-4f2f-83ed-ba03b2cb30de", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-788eee61-2b50-4f2f-83ed-ba03b2cb30de" }, { "name": "List Database Instances", "id": "3fc2acbc-cb4f-412a-a818-b34fb4d63382", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances?tags=&tags=&name=&order_by=created_at_asc&organization_id=&project_id=&has_maintenances=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances" ], "query": [ { "description": "List Database Instances that have a given tag.", "key": "tags", "value": "" }, { "description": "List Database Instances that have a given tag.", "key": "tags", "value": "" }, { "description": "Lists Database Instances that match a name pattern.", "key": "name", "value": "" }, { "description": "Criteria to use when ordering Database Instance listings.", "key": "order_by", "value": "created_at_asc" }, { "description": "Please use project_id instead.", "key": "organization_id", "value": "" }, { "description": "Project ID to list the Database Instance of.", "key": "project_id", "value": "" }, { "description": "Filter to only list instances with a scheduled maintenance.", "key": "has_maintenances", "value": "" }, { "key": "page", "value": "" }, { "key": "page_size", "value": "" } ], "variable": [ { "id": "31467319-cbf7-43fe-904e-fbfe03e7b713", "key": "region", "value": "fr-par", "description": "(Required) The region you want to target" } ] }, "description": "List all Database Instances in the specified region, for a given Scaleway Organization or Scaleway Project. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter." }, "response": [ { "id": "c80cf702-0231-405e-ae78-b89a5ffb8d35", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances?tags=&name=&order_by=created_at_asc&organization_id=&project_id=&has_maintenances=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances" ], "query": [ { "description": "List Database Instances that have a given tag.", "key": "tags", "value": "" }, { "description": "Lists Database Instances that match a name pattern.", "key": "name", "value": "" }, { "description": "Criteria to use when ordering Database Instance listings.", "key": "order_by", "value": "created_at_asc" }, { "description": "Please use project_id instead.", "key": "organization_id", "value": "" }, { "description": "Project ID to list the Database Instance of.", "key": "project_id", "value": "" }, { "description": "Filter to only list instances with a scheduled maintenance.", "key": "has_maintenances", "value": "" }, { "key": "page", "value": "" }, { "key": "page_size", "value": "" } ], "variable": [ { "key": "region" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"instances\": [\n {\n \"created_at\": \"\",\n \"volume\": {\n \"type\": \"lssd\",\n \"size\": \"\",\n \"class\": \"unknown_storage_class\"\n },\n \"region\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"project_id\": \"\",\n \"status\": \"unknown\",\n \"engine\": \"\",\n \"upgradable_version\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"minor_version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"minor_version\": \"\"\n }\n ],\n \"endpoint\": {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"settings\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"backup_schedule\": {\n \"frequency\": \"\",\n \"retention\": \"\",\n \"disabled\": \"\",\n \"next_run_at\": \"\"\n },\n \"is_ha_cluster\": \"\",\n \"read_replicas\": [\n {\n \"id\": \"\",\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"status\": \"unknown\",\n \"region\": \"\",\n \"same_zone\": \"\",\n \"instance_id\": \"\"\n },\n {\n \"id\": \"\",\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"status\": \"unknown\",\n \"region\": \"\",\n \"same_zone\": \"\",\n \"instance_id\": \"\"\n }\n ],\n \"node_type\": \"\",\n \"init_settings\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"logs_policy\": {\n \"max_age_retention\": \"\",\n \"total_disk_retention\": \"\"\n },\n \"backup_same_region\": \"\",\n \"maintenances\": [\n {\n \"starts_at\": \"\",\n \"stops_at\": \"\",\n \"closed_at\": \"\",\n \"reason\": \"\",\n \"status\": \"unknown\",\n \"forced_at\": \"\",\n \"is_applicable\": \"\"\n },\n {\n \"starts_at\": \"\",\n \"stops_at\": \"\",\n \"closed_at\": \"\",\n \"reason\": \"\",\n \"status\": \"unknown\",\n \"forced_at\": \"\",\n \"is_applicable\": \"\"\n }\n ],\n \"encryption\": {\n \"enabled\": \"\"\n }\n },\n {\n \"created_at\": \"\",\n \"volume\": {\n \"type\": \"lssd\",\n \"size\": \"\",\n \"class\": \"unknown_storage_class\"\n },\n \"region\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"project_id\": \"\",\n \"status\": \"unknown\",\n \"engine\": \"\",\n \"upgradable_version\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"minor_version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"minor_version\": \"\"\n }\n ],\n \"endpoint\": {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"settings\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"backup_schedule\": {\n \"frequency\": \"\",\n \"retention\": \"\",\n \"disabled\": \"\",\n \"next_run_at\": \"\"\n },\n \"is_ha_cluster\": \"\",\n \"read_replicas\": [\n {\n \"id\": \"\",\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"status\": \"unknown\",\n \"region\": \"\",\n \"same_zone\": \"\",\n \"instance_id\": \"\"\n },\n {\n \"id\": \"\",\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"status\": \"unknown\",\n \"region\": \"\",\n \"same_zone\": \"\",\n \"instance_id\": \"\"\n }\n ],\n \"node_type\": \"\",\n \"init_settings\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"logs_policy\": {\n \"max_age_retention\": \"\",\n \"total_disk_retention\": \"\"\n },\n \"backup_same_region\": \"\",\n \"maintenances\": [\n {\n \"starts_at\": \"\",\n \"stops_at\": \"\",\n \"closed_at\": \"\",\n \"reason\": \"\",\n \"status\": \"unknown\",\n \"forced_at\": \"\",\n \"is_applicable\": \"\"\n },\n {\n \"starts_at\": \"\",\n \"stops_at\": \"\",\n \"closed_at\": \"\",\n \"reason\": \"\",\n \"status\": \"unknown\",\n \"forced_at\": \"\",\n \"is_applicable\": \"\"\n }\n ],\n \"encryption\": {\n \"enabled\": \"\"\n }\n }\n ],\n \"total_count\": \"\"\n}", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-c80cf702-0231-405e-ae78-b89a5ffb8d35" } ], "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-3fc2acbc-cb4f-412a-a818-b34fb4d63382" }, { "name": "Create a Database Instance", "id": "b8cd9fe1-9247-4d4b-bf1e-e12d6be78d89", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"engine\": \"\",\n \"user_name\": \"\",\n \"password\": \"\",\n \"node_type\": \"\",\n \"organization_id\": \"\",\n \"project_id\": \"\",\n \"name\": \"\",\n \"is_ha_cluster\": \"\",\n \"disable_backup\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"init_settings\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"volume_type\": \"lssd\",\n \"volume_size\": \"\",\n \"init_endpoints\": [\n {\n \"load_balancer\": {},\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"ipam_config\": {}\n }\n },\n {\n \"load_balancer\": {},\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"ipam_config\": {}\n }\n }\n ],\n \"backup_same_region\": \"\",\n \"encryption\": {\n \"enabled\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances" ], "variable": [ { "id": "7974d6df-22e2-4bba-a234-79c1a3b65275", "key": "region", "value": "fr-par", "description": "(Required) The region you want to target" } ] }, "description": "Create a new Database Instance. You must set the `engine`, `user_name`, `password` and `node_type` parameters. Optionally, you can specify the volume type and size." }, "response": [ { "id": "0faf87d8-7f15-429f-95e4-5beb21c4773a", "name": "New Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"engine\": \"\",\n \"user_name\": \"\",\n \"password\": \"\",\n \"node_type\": \"\",\n \"organization_id\": \"\",\n \"project_id\": \"\",\n \"name\": \"\",\n \"is_ha_cluster\": \"\",\n \"disable_backup\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"init_settings\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"volume_type\": \"lssd\",\n \"volume_size\": \"\",\n \"init_endpoints\": [\n {\n \"load_balancer\": {},\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"ipam_config\": {}\n }\n },\n {\n \"load_balancer\": {},\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"ipam_config\": {}\n }\n }\n ],\n \"backup_same_region\": \"\",\n \"encryption\": {\n \"enabled\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/instances", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "instances" ], "variable": [ { "key": "region" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"created_at\": \"\",\n \"volume\": {\n \"type\": \"lssd\",\n \"size\": \"\",\n \"class\": \"unknown_storage_class\"\n },\n \"region\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"organization_id\": \"\",\n \"project_id\": \"\",\n \"status\": \"unknown\",\n \"engine\": \"\",\n \"upgradable_version\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"minor_version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"minor_version\": \"\"\n }\n ],\n \"endpoint\": {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n \"tags\": [\n \"\",\n \"\"\n ],\n \"settings\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"backup_schedule\": {\n \"frequency\": \"\",\n \"retention\": \"\",\n \"disabled\": \"\",\n \"next_run_at\": \"\"\n },\n \"is_ha_cluster\": \"\",\n \"read_replicas\": [\n {\n \"id\": \"\",\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"status\": \"unknown\",\n \"region\": \"\",\n \"same_zone\": \"\",\n \"instance_id\": \"\"\n },\n {\n \"id\": \"\",\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"status\": \"unknown\",\n \"region\": \"\",\n \"same_zone\": \"\",\n \"instance_id\": \"\"\n }\n ],\n \"node_type\": \"\",\n \"init_settings\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"endpoints\": [\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n },\n {\n \"id\": \"\",\n \"ip\": \"\",\n \"port\": \"\",\n \"name\": \"\",\n \"private_network\": {\n \"private_network_id\": \"\",\n \"service_ip\": \"\",\n \"zone\": \"\",\n \"provisioning_mode\": \"static\"\n },\n \"load_balancer\": {},\n \"direct_access\": {},\n \"hostname\": \"\"\n }\n ],\n \"logs_policy\": {\n \"max_age_retention\": \"\",\n \"total_disk_retention\": \"\"\n },\n \"backup_same_region\": \"\",\n \"maintenances\": [\n {\n \"starts_at\": \"\",\n \"stops_at\": \"\",\n \"closed_at\": \"\",\n \"reason\": \"\",\n \"status\": \"unknown\",\n \"forced_at\": \"\",\n \"is_applicable\": \"\"\n },\n {\n \"starts_at\": \"\",\n \"stops_at\": \"\",\n \"closed_at\": \"\",\n \"reason\": \"\",\n \"status\": \"unknown\",\n \"forced_at\": \"\",\n \"is_applicable\": \"\"\n }\n ],\n \"encryption\": {\n \"enabled\": \"\"\n }\n}", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-0faf87d8-7f15-429f-95e4-5beb21c4773a" } ], "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-b8cd9fe1-9247-4d4b-bf1e-e12d6be78d89" } ], "id": "c1a50f48-ef47-496b-ae69-a18e1eb8c025", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-c1a50f48-ef47-496b-ae69-a18e1eb8c025" }, { "name": "logs", "item": [ { "name": "{instance_log_id}", "item": [ { "name": "Get given logs of a Database Instance", "id": "5a5c3b06-0498-4315-bc35-840ef91f68d8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/logs/:instance_log_id", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "logs", ":instance_log_id" ], "variable": [ { "id": "5ee0359e-2cec-440b-9688-88665778ca05", "key": "region", "value": "fr-par", "description": "(Required) The region you want to target" }, { "id": "48dc4732-d886-4606-8192-628462dbb396", "key": "instance_log_id", "value": "", "description": "(Required) UUID of the instance_log you want." } ] }, "description": "Retrieve information about the logs of a Database Instance. Specify the `instance_log_id` and `region` in your request to get information such as `download_url`, `status`, `expires_at` and `created_at` about your logs in the response." }, "response": [ { "id": "caa7b155-0d32-4467-93b0-9bee1b4e3ed6", "name": "New Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Auth-Token", "value": "" } ], "url": { "raw": "{{baseUrl}}/rdb/v1/regions/:region/logs/:instance_log_id", "host": [ "{{baseUrl}}" ], "path": [ "rdb", "v1", "regions", ":region", "logs", ":instance_log_id" ], "variable": [ { "key": "region" }, { "key": "instance_log_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"download_url\": \"\",\n \"id\": \"\",\n \"status\": \"unknown\",\n \"node_name\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"region\": \"\"\n}", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-caa7b155-0d32-4467-93b0-9bee1b4e3ed6" } ], "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-5a5c3b06-0498-4315-bc35-840ef91f68d8" } ], "id": "d9b4365c-c738-4044-b9fb-fb28b535df02", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-d9b4365c-c738-4044-b9fb-fb28b535df02" } ], "id": "6253f8c2-7a5f-44b1-88b7-d2f684e8a75e", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-6253f8c2-7a5f-44b1-88b7-d2f684e8a75e" } ], "id": "7f0dfcc3-71f5-4818-9e7a-4133d0d4a9d6", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-7f0dfcc3-71f5-4818-9e7a-4133d0d4a9d6" } ], "id": "d6c86020-4ce8-4aad-b249-9ecfe863c90a", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-d6c86020-4ce8-4aad-b249-9ecfe863c90a" } ], "id": "29857fc8-c80b-4ed0-a7be-a32d8703ff48", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-29857fc8-c80b-4ed0-a7be-a32d8703ff48" } ], "id": "fe2f8026-66ab-4378-9153-bf7db17157df", "createdAt": "2026-07-28T02:51:56.000Z", "updatedAt": "2026-07-28T02:51:56.000Z", "uid": "35240-fe2f8026-66ab-4378-9153-bf7db17157df" } ], "variable": [ { "key": "baseUrl", "value": "https://api.scaleway.com" } ] }