{ "opencollection": "1.0.0", "info": { "name": "Managed Database for PostgreSQL and MySQL API", "version": "v1" }, "items": [ { "info": { "name": "Backups", "type": "folder" }, "items": [ { "info": { "name": "List database backups", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/rdb/v1/regions/:region/backups", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "name", "value": "", "type": "query", "description": "Name of the database backups." }, { "name": "order_by", "value": "", "type": "query", "description": "Criteria to use when ordering database backups listing." }, { "name": "instance_id", "value": "", "type": "query", "description": "UUID of the Database Instance." }, { "name": "organization_id", "value": "", "type": "query", "description": "Organization ID of the Organization the database backups belong to." }, { "name": "project_id", "value": "", "type": "query", "description": "Project ID of the Project the database backups belong to." }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all backups in a specified region, for a given Scaleway Organization or Scaleway Project. By default, the backups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field." }, { "info": { "name": "Create a database backup", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/backups", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Create a new backup. You must set the `instance_id`, `database_name`, `name` and `expires_at` parameters." }, { "info": { "name": "Get a database backup", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/rdb/v1/regions/:region/backups/:database_backup_id", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "database_backup_id", "value": "", "type": "path", "description": "UUID of the database backup." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve information about a given backup, specified by its database backup ID and region. Full details about the backup, like size, URL and expiration date, are returned in the response." }, { "info": { "name": "Update a database backup", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/rdb/v1/regions/:region/backups/:database_backup_id", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "database_backup_id", "value": "", "type": "path", "description": "UUID of the database backup to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the parameters of a backup, including name and expiration date." }, { "info": { "name": "Delete a database backup", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/rdb/v1/regions/:region/backups/:database_backup_id", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "database_backup_id", "value": "", "type": "path", "description": "UUID of the database backup to delete." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete a backup, specified by its database backup ID and region. Deleting a backup is permanent, and cannot be undone." }, { "info": { "name": "Export a database backup", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/backups/:database_backup_id/export", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "database_backup_id", "value": "", "type": "path", "description": "UUID of the database backup you want to export." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Export a backup, specified by the `database_backup_id` and the `region` parameters. The download URL is returned in the response." }, { "info": { "name": "Restore a database backup", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/backups/:database_backup_id/restore", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "database_backup_id", "value": "", "type": "path", "description": "Backup of a logical database." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Launch the process of restoring database backup. You must specify the `instance_id` of the Database Instance of destination, where the backup will be restored. Note that large database backups can take up to several hours to restore." } ] }, { "info": { "name": "Engines", "type": "folder" }, "items": [ { "info": { "name": "List available database engines", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/rdb/v1/regions/:region/database-engines", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "name", "value": "", "type": "query", "description": "Name of the database engine." }, { "name": "version", "value": "", "type": "query", "description": "Version of the database engine." }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List the PostgreSQL and MySQL database engines available at Scaleway." } ] }, { "info": { "name": "Endpoints", "type": "folder" }, "items": [ { "info": { "name": "Get a Database Instance endpoint", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/rdb/v1/regions/:region/endpoints/:endpoint_id", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "endpoint_id", "value": "", "type": "path", "description": "UUID of the endpoint you want to get." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve information about a Database Instance endpoint. Full details about the endpoint, like `ip`, `port`, `private_network` and `load_balancer` specifications are returned in the response." }, { "info": { "name": "Delete a Database Instance endpoint", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/rdb/v1/regions/:region/endpoints/:endpoint_id", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "endpoint_id", "value": "", "type": "path", "description": "UUID of the endpoint you want to delete.\nThis endpoint can also be used to delete a Read Replica endpoint." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete the endpoint of a Database Instance. You must specify the `region` and `endpoint_id` parameters of the endpoint you want to delete. Note that might need to update any environment configurations that point to the deleted endpoint." }, { "info": { "name": "Migrate an existing instance endpoint to another instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/endpoints/:endpoint_id/migrate", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "endpoint_id", "value": "", "type": "path", "description": "UUID of the endpoint you want to migrate." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Migrate an existing instance endpoint to another instance" }, { "info": { "name": "Create a new Database Instance endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/endpoints", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance you to which you want to add an endpoint." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Create a new endpoint for a Database Instance. You can add `load_balancer` and `private_network` specifications to the body of the request." } ] }, { "info": { "name": "Database Instances", "type": "folder" }, "items": [ { "info": { "name": "List Database Instances", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "tags", "value": "", "type": "query", "description": "List Database Instances that have a given tag." }, { "name": "name", "value": "", "type": "query", "description": "Lists Database Instances that match a name pattern." }, { "name": "order_by", "value": "", "type": "query", "description": "Criteria to use when ordering Database Instance listings." }, { "name": "organization_id", "value": "", "type": "query", "description": "Please use project_id instead." }, { "name": "project_id", "value": "", "type": "query", "description": "Project ID to list the Database Instance of." }, { "name": "has_maintenances", "value": "", "type": "query", "description": "Filter to only list instances with a scheduled maintenance." }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "Create a Database Instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "Get a Database Instance", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "Update a Database Instance", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the parameters of a Database Instance, including name, tags and backup schedule details." }, { "info": { "name": "Delete a Database Instance", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance to delete." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "Apply Database Instance maintenance", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/apply-maintenance", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance you want to apply maintenance." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "Get the TLS certificate of a Database Instance", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/certificate", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve information about the TLS certificate of a given Database Instance. Details like name and content are returned in the response." }, { "info": { "name": "Clone a Database Instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/clone", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance you want to clone." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "List available logs of a Database Instance", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/logs", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance you want logs of." }, { "name": "order_by", "value": "", "type": "query", "description": "Criteria to use when ordering Database Instance logs listing." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "List remote Database Instance logs details", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/logs-details", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance you want logs of." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "[deprecated] Get Database Instance metrics", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/metrics", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance." }, { "name": "start_date", "value": "", "type": "query", "description": "Start date to gather metrics from. (RFC 3339 format)" }, { "name": "end_date", "value": "", "type": "query", "description": "End date to gather metrics from. (RFC 3339 format)" }, { "name": "metric_name", "value": "", "type": "query", "description": "Name of the metric to gather." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "Prepare logs of a Database Instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/prepare-logs", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance you want logs of." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "Purge remote Database Instance logs", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/purge-logs", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance you want logs of." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "Renew the TLS certificate of a Database Instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/renew-certificate", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance you want logs of." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "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." }, { "info": { "name": "Restart Database Instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/restart", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance you want to restart." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Restart a given Database Instance, specified by the `region` and `instance_id` parameters. The status of the Database Instance returned in the response." }, { "info": { "name": "Upgrade a Database Instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/upgrade", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance you want to upgrade." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "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`." }, { "info": { "name": "Get given logs of a Database Instance", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/rdb/v1/regions/:region/logs/:instance_log_id", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_log_id", "value": "", "type": "path", "description": "UUID of the instance_log you want." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "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." } ] }, { "info": { "name": "ACLs", "type": "folder" }, "items": [ { "info": { "name": "List ACL rules of a Database Instance", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/acls", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance." }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List the ACL rules for a given Database Instance. The response is an array of ACL objects, each one representing an ACL that denies, allows or redirects traffic based on certain conditions." }, { "info": { "name": "Add an ACL rule to a Database Instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/acls", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance you want to add ACL rules to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Add an additional ACL rule to a Database Instance." }, { "info": { "name": "Set ACL rules for a Database Instance", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/acls", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance where the ACL rules must be set." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Replace all the ACL rules of a Database Instance." }, { "info": { "name": "Delete ACL rules of a Database Instance", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/acls", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance you want to delete an ACL rule from." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete one or more ACL rules of a Database Instance." } ] }, { "info": { "name": "Databases", "type": "folder" }, "items": [ { "info": { "name": "List databases in a Database Instance", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/databases", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance to list the databases of." }, { "name": "name", "value": "", "type": "query", "description": "Name of the database." }, { "name": "managed", "value": "", "type": "query", "description": "Defines whether or not the database is managed." }, { "name": "owner", "value": "", "type": "query", "description": "User that owns this database." }, { "name": "order_by", "value": "", "type": "query", "description": "Criteria to use when ordering database listing." }, { "name": "skip_size_retrieval", "value": "", "type": "query", "description": "Whether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0." }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all databases of a given Database Instance. By default, the databases 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 `name`, `managed` and `owner`." }, { "info": { "name": "Create a database in a Database Instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/databases", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance where to create the database." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Create a new database. You must define the `name` parameter in the request." }, { "info": { "name": "Delete a database in a Database Instance", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/databases/:name", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance where to delete the database." }, { "name": "name", "value": "", "type": "path", "description": "Name of the database to delete." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete a given database on a Database Instance. You must specify, in the endpoint, the `region`, `instance_id` and `name` parameters of the database you want to delete." } ] }, { "info": { "name": "Privileges", "type": "folder" }, "items": [ { "info": { "name": "List user privileges for a database", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/privileges", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance." }, { "name": "order_by", "value": "", "type": "query", "description": "Criteria to use when ordering privileges listing." }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" }, { "name": "database_name", "value": "", "type": "query", "description": "Name of the database." }, { "name": "user_name", "value": "", "type": "query", "description": "Name of the user." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List privileges of a user on a database. 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. You can define additional parameters for your query, such as `database_name` and `user_name`." }, { "info": { "name": "Set user privileges for a database", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/privileges", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Set the privileges of a user on a database. You must define `database_name`, `user_name` and `permission` in the request body." } ] }, { "info": { "name": "Instance Settings", "type": "folder" }, "items": [ { "info": { "name": "Add Database Instance advanced settings", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/settings", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance you want to add settings to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Add an advanced setting to a Database Instance. You must set the `name` and the `value` of each setting." }, { "info": { "name": "Set Database Instance advanced settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/settings", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance where the settings must be set." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update an advanced setting for a Database Instance. Settings added upon database engine initialization can only be defined once, and cannot, therefore, be updated." }, { "info": { "name": "Delete Database Instance advanced settings", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/settings", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance to delete settings from." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete an advanced setting in a Database Instance. You must specify the names of the settings you want to delete in the request." } ] }, { "info": { "name": "Snapshots", "type": "folder" }, "items": [ { "info": { "name": "Create a Database Instance snapshot", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/snapshots", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Create a new snapshot of a Database Instance. You must define the `name` parameter in the request." }, { "info": { "name": "List snapshots", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/rdb/v1/regions/:region/snapshots", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "name", "value": "", "type": "query", "description": "Name of the snapshot." }, { "name": "order_by", "value": "", "type": "query", "description": "Criteria to use when ordering snapshot listing." }, { "name": "instance_id", "value": "", "type": "query", "description": "UUID of the Database Instance." }, { "name": "organization_id", "value": "", "type": "query", "description": "Organization ID the snapshots belongs to." }, { "name": "project_id", "value": "", "type": "query", "description": "Project ID the snapshots belongs to." }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List snapshots. You can include the `instance_id` or `project_id` in your query to get the list of snapshots for specific Database Instances and/or Projects. 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." }, { "info": { "name": "Get a Database Instance snapshot", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/rdb/v1/regions/:region/snapshots/:snapshot_id", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "snapshot_id", "value": "", "type": "path", "description": "UUID of the snapshot." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve information about a given snapshot, specified by its `snapshot_id` and `region`. Full details about the snapshot, like size and expiration date, are returned in the response." }, { "info": { "name": "Update a Database Instance snapshot", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/rdb/v1/regions/:region/snapshots/:snapshot_id", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "snapshot_id", "value": "", "type": "path", "description": "UUID of the snapshot to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the parameters of a snapshot of a Database Instance. You can update the `name` and `expires_at` parameters." }, { "info": { "name": "Delete a Database Instance snapshot", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/rdb/v1/regions/:region/snapshots/:snapshot_id", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "snapshot_id", "value": "", "type": "path", "description": "UUID of the snapshot to delete." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the `region` and `snapshot_id` parameters of the snapshot you want to delete." }, { "info": { "name": "Create a new Database Instance from a snapshot", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/snapshots/:snapshot_id/create-instance", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "snapshot_id", "value": "", "type": "path", "description": "Block snapshot of the Database Instance." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Restore a snapshot. When you restore a snapshot, a new Instance is created and billed to your account. Note that is possible to select a larger node type for your new Database Instance. However, the Block volume size will be the same as the size of the restored snapshot. All Instance settings will be restored if you chose a node type with the same or more memory size than the initial Instance. Settings will be reset to the default if your node type has less memory." } ] }, { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "List users of a Database Instance", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/users", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance." }, { "name": "name", "value": "", "type": "query", "description": "Name of the user." }, { "name": "order_by", "value": "", "type": "query", "description": "Criteria to use when requesting user listing." }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all users of a given Database Instance. By default, the users returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field." }, { "info": { "name": "Create a user for a Database Instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/users", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance in which you want to create a user." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Create a new user for a Database Instance. You must define the `name`, `password` and `is_admin` parameters." }, { "info": { "name": "Update a user on a Database Instance", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/users/:name", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance the user belongs to." }, { "name": "name", "value": "", "type": "path", "description": "Name of the database user." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the parameters of a user on a Database Instance. You can update the `password` and `is_admin` parameters, but you cannot change the name of the user." }, { "info": { "name": "Delete a user on a Database Instance", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/rdb/v1/regions/:region/instances/:instance_id/users/:name", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "instance_id", "value": "", "type": "path", "description": "UUID of the Database Instance to delete the user from." }, { "name": "name", "value": "", "type": "path", "description": "Name of the user." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete a given user on a Database Instance. You must specify, in the endpoint, the `region`, `instance_id` and `name` parameters of the user you want to delete." } ] }, { "info": { "name": "NodeTypes", "type": "folder" }, "items": [ { "info": { "name": "List available node types", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/rdb/v1/regions/:region/node-types", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "include_disabled_types", "value": "", "type": "query", "description": "Defines whether or not to include disabled types." }, { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field." } ] }, { "info": { "name": "Read Replicas", "type": "folder" }, "items": [ { "info": { "name": "Create a Read Replica", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/read-replicas", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Create a new Read Replica of a Database Instance. You must specify the `region` and the `instance_id`. You can only create a maximum of 3 Read Replicas per Database Instance." }, { "info": { "name": "Get a Read Replica", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/rdb/v1/regions/:region/read-replicas/:read_replica_id", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "read_replica_id", "value": "", "type": "path", "description": "UUID of the Read Replica. (UUID format)" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve information about a Database Instance Read Replica. Full details about the Read Replica, like `endpoints`, `status` and `region` are returned in the response." }, { "info": { "name": "Delete a Read Replica", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/rdb/v1/regions/:region/read-replicas/:read_replica_id", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "read_replica_id", "value": "", "type": "path", "description": "UUID of the Read Replica. (UUID format)" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete a Read Replica of a Database Instance. You must specify the `region` and `read_replica_id` parameters of the Read Replica you want to delete." }, { "info": { "name": "Create an endpoint for a Read Replica", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/read-replicas/:read_replica_id/endpoints", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "read_replica_id", "value": "", "type": "path", "description": "UUID of the Read Replica. (UUID format)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Create a new endpoint for a Read Replica. Read Replicas can have at most one direct access and one Private Network endpoint." }, { "info": { "name": "Promote a Read Replica", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/read-replicas/:read_replica_id/promote", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "read_replica_id", "value": "", "type": "path", "description": "UUID of the Read Replica. (UUID format)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Promote a Read Replica to Database Instance automatically." }, { "info": { "name": "Resync a Read Replica", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/rdb/v1/regions/:region/read-replicas/:read_replica_id/reset", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "read_replica_id", "value": "", "type": "path", "description": "UUID of the Read Replica. (UUID format)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "When you resync a Read Replica, first it is reset, then its data is resynchronized from the primary node. Your Read Replica remains unavailable during the resync process. The duration of this process is proportional to the size of your Database Instance.\nThe configured endpoints do not change." } ] } ], "bundled": true }