{ "opencollection": "1.0.0", "info": { "name": "Managed Database for PostgreSQL and MySQL Access Control List Load Balancer API", "version": "v1" }, "items": [ { "info": { "name": "Load Balancer", "type": "folder" }, "items": [ { "info": { "name": "List Load Balancers", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lbs", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "name", "value": "", "type": "query", "description": "Load Balancer name to filter for." }, { "name": "order_by", "value": "", "type": "query", "description": "Sort order of Load Balancers in the response." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of Load Balancers to return." }, { "name": "page", "value": "", "type": "query", "description": "Page number to return, from the paginated results." }, { "name": "organization_id", "value": "", "type": "query", "description": "Organization ID to filter for, only Load Balancers from this Organization will be returned." }, { "name": "project_id", "value": "", "type": "query", "description": "Project ID to filter for, only Load Balancers from this Project will be returned." }, { "name": "tags", "value": "", "type": "query", "description": "Filter by tag, only Load Balancers with one or more matching tags will be returned." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all Load Balancers in the specified zone, for a Scaleway Organization or Scaleway Project. By default, the Load Balancers 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 Load Balancer", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lbs", "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 new Load Balancer. Note that the Load Balancer will be created without frontends or backends; these must be created separately via the dedicated endpoints." }, { "info": { "name": "Get a Load Balancer", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lbs/:lb_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "lb_id", "value": "", "type": "path", "description": "Load Balancer ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve information about an existing Load Balancer, specified by its Load Balancer ID. Its full details, including name, status and IP address, are returned in the response object." }, { "info": { "name": "Update a Load Balancer", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lbs/:lb_id", "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": "Update the parameters of an existing Load Balancer, specified by its Load Balancer ID. Note that the request type is PUT and not PATCH. You must set all parameters." }, { "info": { "name": "Delete a Load Balancer", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lbs/:lb_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "lb_id", "value": "", "type": "path", "description": "ID of the Load Balancer to delete." }, { "name": "release_ip", "value": "", "type": "query", "description": "Defines whether the Load Balancer's flexible IP should be deleted. Set to true to release the flexible IP, or false to keep it available in your account for future Load Balancers." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete an existing Load Balancer, specified by its Load Balancer ID. Deleting a Load Balancer is permanent, and cannot be undone. The Load Balancer's flexible IP address can either be deleted with the Load Balancer, or kept in your account for future use." }, { "info": { "name": "Migrate a Load Balancer", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lbs/:lb_id/migrate", "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": "Migrate an existing Load Balancer from one commercial type to another. Allows you to scale your Load Balancer up or down in terms of bandwidth or multi-cloud provision." } ] } ], "bundled": true }