{ "opencollection": "1.0.0", "info": { "name": "Managed Database for PostgreSQL and MySQL Access Control List ACLs API", "version": "v1" }, "items": [ { "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": "Get an ACL", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/acls/:acl_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "acl_id", "value": "", "type": "path", "description": "ACL ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get information for a particular ACL, specified by its ACL ID. The response returns full details of the ACL, including its name, action, match rule and frontend." }, { "info": { "name": "Update an ACL", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/lb/v1/zones/:zone/acls/:acl_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "acl_id", "value": "", "type": "path", "description": "ACL ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update a particular ACL, specified by its ACL ID. You can update details including its name, action and match rule." }, { "info": { "name": "Delete an ACL", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/lb/v1/zones/:zone/acls/:acl_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "acl_id", "value": "", "type": "path", "description": "ACL ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete an ACL, specified by its ACL ID. Deleting an ACL is irreversible and cannot be undone." }, { "info": { "name": "List ACLs for a given frontend", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/frontends/:frontend_id/acls", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "frontend_id", "value": "", "type": "path", "description": "Frontend ID (ACLs attached to this frontend will be returned in the response)." }, { "name": "order_by", "value": "", "type": "query", "description": "Sort order of ACLs in the response." }, { "name": "page", "value": "", "type": "query", "description": "The page number to return, from the paginated results." }, { "name": "page_size", "value": "", "type": "query", "description": "The number of ACLs to return." }, { "name": "name", "value": "", "type": "query", "description": "ACL name to filter for." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List the ACLs for a given frontend, specified by its frontend ID. The response is an array of ACL objects, each one representing an ACL that denies or allows traffic based on certain conditions." }, { "info": { "name": "Create an ACL for a given frontend", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/lb/v1/zones/:zone/frontends/:frontend_id/acls", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "frontend_id", "value": "", "type": "path", "description": "Frontend ID to attach the ACL to." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Create a new ACL for a given frontend. Each ACL must have a name, an action to perform (allow or deny), and a match rule (the action is carried out when the incoming traffic matches the rule)." }, { "info": { "name": "Define all ACLs for a given frontend", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/lb/v1/zones/:zone/frontends/:frontend_id/acls", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "frontend_id", "value": "", "type": "path", "description": "Frontend ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "For a given frontend specified by its frontend ID, define and add the complete set of ACLS for that frontend. Any existing ACLs on this frontend will be removed." } ] } ], "bundled": true }