{ "opencollection": "1.0.0", "info": { "name": "Managed Database for PostgreSQL and MySQL Access Control List Backups 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." } ] } ], "bundled": true }