{ "opencollection": "1.0.0", "info": { "name": "Managed Database for PostgreSQL and MySQL Access Control List Security Groups API", "version": "v1" }, "items": [ { "info": { "name": "Security Groups", "type": "folder" }, "items": [ { "info": { "name": "List security groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "name", "value": "", "type": "query", "description": "Name of the security group." }, { "name": "organization", "value": "", "type": "query", "description": "Security group Organization ID." }, { "name": "project", "value": "", "type": "query", "description": "Security group Project ID." }, { "name": "tags", "value": "", "type": "query", "description": "List security groups with these exact tags (to filter with several tags, use commas to separate them)." }, { "name": "project_default", "value": "", "type": "query", "description": "Filter security groups with this value for project_default." }, { "name": "per_page", "value": "", "type": "query", "description": "A positive integer lower or equal to 100 to select the number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A positive integer to choose the page to return." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all existing security groups." }, { "info": { "name": "Create a security group", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Create a security group with a specified name and description." }, { "info": { "name": "Update a security group", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "id", "value": "", "type": "path", "description": "UUID of the security group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Replace all security group properties with a security group message." }, { "info": { "name": "Get a security group", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:security_group_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "security_group_id", "value": "", "type": "path", "description": "UUID of the security group you want to get." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get the details of a security group with the specified ID." }, { "info": { "name": "Update a security group", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:security_group_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "security_group_id", "value": "", "type": "path", "description": "UUID of the security group. (UUID format)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the properties of security group." }, { "info": { "name": "Delete a security group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:security_group_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "security_group_id", "value": "", "type": "path", "description": "UUID of the security group you want to delete." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete a security group with the specified ID." }, { "info": { "name": "List rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:security_group_id/rules", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "security_group_id", "value": "", "type": "path", "description": "UUID of the security group." }, { "name": "per_page", "value": "", "type": "query", "description": "A positive integer lower or equal to 100 to select the number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A positive integer to choose the page to return." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List the rules of the a specified security group ID." }, { "info": { "name": "Create rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:security_group_id/rules", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "security_group_id", "value": "", "type": "path", "description": "UUID of the security group." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Create a rule in the specified security group ID." }, { "info": { "name": "Update all the rules of a security group", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:security_group_id/rules", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "security_group_id", "value": "", "type": "path", "description": "UUID of the security group to update the rules on." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Replaces the existing rules of the security group with the rules provided. This endpoint supports the update of existing rules, creation of new rules and deletion of existing rules when they are not passed in the request." }, { "info": { "name": "Get rule", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:security_group_id/rules/:security_group_rule_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "security_group_id", "value": "", "type": "path" }, { "name": "security_group_rule_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get details of a security group rule with the specified ID." }, { "info": { "name": "Set security group rule", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:security_group_id/rules/:security_group_rule_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "security_group_id", "value": "", "type": "path" }, { "name": "security_group_rule_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Replace all the properties of a rule from a specified security group." }, { "info": { "name": "Update security group rule", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:security_group_id/rules/:security_group_rule_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "security_group_id", "value": "", "type": "path", "description": "UUID of the security group. (UUID format)" }, { "name": "security_group_rule_id", "value": "", "type": "path", "description": "UUID of the rule. (UUID format)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the properties of a rule from a specified security group." }, { "info": { "name": "Delete rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/:security_group_id/rules/:security_group_rule_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "security_group_id", "value": "", "type": "path" }, { "name": "security_group_rule_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete a security group rule with the specified ID." }, { "info": { "name": "Get default rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/instance/v1/zones/:zone/security_groups/default/rules", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Lists the default rules applied to all the security groups." } ] } ], "bundled": true }