{ "opencollection": "1.0.0", "info": { "name": "Managed Database for PostgreSQL and MySQL Access Control List Read Replicas API", "version": "v1" }, "items": [ { "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 }