{ "opencollection": "1.0.0", "info": { "name": "Managed Database for PostgreSQL and MySQL Access Control List Private Networks API", "version": "v1" }, "items": [ { "info": { "name": "Private Networks", "type": "folder" }, "items": [ { "info": { "name": "Attach a Load Balancer to a Private Network", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lbs/:lb_id/attach-private-network", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "lb_id", "value": "", "type": "path", "description": "Load Balancer ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Attach a specified Load Balancer to a specified Private Network, defining a static or DHCP configuration for the Load Balancer on the network." }, { "info": { "name": "Detach Load Balancer from Private Network", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lbs/:lb_id/detach-private-network", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "lb_id", "value": "", "type": "path", "description": "Load balancer ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Detach a specified Load Balancer from a specified Private Network." }, { "info": { "name": "List Private Networks attached to a Load Balancer", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lbs/:lb_id/private-networks", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "lb_id", "value": "", "type": "path", "description": "Load Balancer ID." }, { "name": "order_by", "value": "", "type": "query", "description": "Sort order of Private Network objects in the response." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of objects to return." }, { "name": "page", "value": "", "type": "query", "description": "The page number to return, from the paginated results." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List the Private Networks attached to a given Load Balancer, specified by its Load Balancer ID. The response is an array of Private Network objects, giving information including the status, configuration, name and creation date of each Private Network." }, { "info": { "name": "List Private Networks", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/vpc/v2/regions/:region/private-networks", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "order_by", "value": "", "type": "query", "description": "Sort order of the returned Private Networks." }, { "name": "page", "value": "", "type": "query", "description": "Page number to return, from the paginated results." }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum number of Private Networks to return per page." }, { "name": "name", "value": "", "type": "query", "description": "Name to filter for. Only Private Networks with names containing this string will be returned." }, { "name": "tags", "value": "", "type": "query", "description": "Tags to filter for. Only Private Networks with one or more matching tags will be returned." }, { "name": "organization_id", "value": "", "type": "query", "description": "Organization ID to filter for. Only Private Networks belonging to this Organization will be returned. (UUID format)" }, { "name": "project_id", "value": "", "type": "query", "description": "Project ID to filter for. Only Private Networks belonging to this Project will be returned. (UUID format)" }, { "name": "private_network_ids", "value": "", "type": "query", "description": "Private Network IDs to filter for. Only Private Networks with one of these IDs will be returned." }, { "name": "vpc_id", "value": "", "type": "query", "description": "VPC ID to filter for. Only Private Networks belonging to this VPC will be returned. (UUID format)" }, { "name": "dhcp_enabled", "value": "", "type": "query", "description": "DHCP status to filter for. When true, only Private Networks with managed DHCP enabled will be returned." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List existing Private Networks in the specified region. By default, the Private Networks 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 Private Network", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/vpc/v2/regions/:region/private-networks", "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 Private Network. Once created, you can attach Scaleway resources which are in the same region." }, { "info": { "name": "Get a Private Network", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/vpc/v2/regions/:region/private-networks/:private_network_id", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "private_network_id", "value": "", "type": "path", "description": "Private Network ID. (UUID format)" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve information about an existing Private Network, specified by its Private Network ID. Its full details are returned in the response object." }, { "info": { "name": "Update Private Network", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/vpc/v2/regions/:region/private-networks/:private_network_id", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "private_network_id", "value": "", "type": "path", "description": "Private Network ID. (UUID format)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update parameters (such as name or tags) of an existing Private Network, specified by its Private Network ID." }, { "info": { "name": "Delete a Private Network", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/vpc/v2/regions/:region/private-networks/:private_network_id", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "private_network_id", "value": "", "type": "path", "description": "Private Network ID. (UUID format)" } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete an existing Private Network. Note that you must first detach all resources from the network, in order to delete it." }, { "info": { "name": "Enable DHCP on a Private Network", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/vpc/v2/regions/:region/private-networks/:private_network_id/enable-dhcp", "params": [ { "name": "region", "value": "", "type": "path", "description": "The region you want to target" }, { "name": "private_network_id", "value": "", "type": "path", "description": "Private Network ID. (UUID format)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Enable DHCP managed on an existing Private Network. Note that you will not be able to deactivate it afterwards." } ] } ], "bundled": true }