{ "opencollection": "1.0.0", "info": { "name": "Load Balancer API", "version": "v1" }, "items": [ { "info": { "name": "ACLs", "type": "folder" }, "items": [ { "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." } ] }, { "info": { "name": "Backends", "type": "folder" }, "items": [ { "info": { "name": "Get a backend of a given Load Balancer", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/backends/:backend_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "backend_id", "value": "", "type": "path", "description": "Backend ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get the full details of a given backend, specified by its backend ID. The response contains the backend's full configuration parameters including protocol, port and forwarding algorithm." }, { "info": { "name": "Update a backend of a given Load Balancer", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/lb/v1/zones/:zone/backends/:backend_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "backend_id", "value": "", "type": "path", "description": "Backend ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update a backend of a given Load Balancer, specified by its backend ID. Note that the request type is PUT and not PATCH. You must set all parameters." }, { "info": { "name": "Delete a backend of a given Load Balancer", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/lb/v1/zones/:zone/backends/:backend_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "backend_id", "value": "", "type": "path", "description": "ID of the backend to delete." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete a backend of a given Load Balancer, specified by its backend ID. This action is irreversible and cannot be undone." }, { "info": { "name": "Update a health check for a given backend", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/lb/v1/zones/:zone/backends/:backend_id/healthcheck", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "backend_id", "value": "", "type": "path", "description": "Backend ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the configuration of the health check performed by a given backend to verify the health of its backend servers, identified by its backend ID. Note that the request type is PUT and not PATCH. You must set all parameters." }, { "info": { "name": "Add a set of backend servers to a given backend", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/lb/v1/zones/:zone/backends/:backend_id/servers", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "backend_id", "value": "", "type": "path", "description": "Backend ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "For a given backend specified by its backend ID, add a set of backend servers (identified by their IP addresses) it should forward traffic to. These will be appended to any existing set of backend servers for this backend." }, { "info": { "name": "Define all backend servers for a given backend", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/lb/v1/zones/:zone/backends/:backend_id/servers", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "backend_id", "value": "", "type": "path", "description": "Backend ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "For a given backend specified by its backend ID, define the set of backend servers (identified by their IP addresses) that it should forward traffic to. Any existing backend servers configured for this backend will be removed." }, { "info": { "name": "Remove a set of servers for a given backend", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/lb/v1/zones/:zone/backends/:backend_id/servers", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "backend_id", "value": "", "type": "path", "description": "Backend ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "For a given backend specified by its backend ID, remove the specified backend servers (identified by their IP addresses) so that it no longer forwards traffic to them." }, { "info": { "name": "List backend server statistics", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lbs/:lb_id/backend-stats", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "lb_id", "value": "", "type": "path", "description": "Load Balancer ID." }, { "name": "page", "value": "", "type": "query", "description": "The page number to return, from the paginated results." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of items to return." }, { "name": "backend_id", "value": "", "type": "query", "description": "ID of the backend." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List information about your backend servers, including their state and the result of their last health check." }, { "info": { "name": "List the backends of a given Load Balancer", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lbs/:lb_id/backends", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "lb_id", "value": "", "type": "path", "description": "Load Balancer ID." }, { "name": "name", "value": "", "type": "query", "description": "Name of the backend to filter for." }, { "name": "order_by", "value": "", "type": "query", "description": "Sort order of backends 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": "Number of backends to return." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all the backends of a Load Balancer, specified by its Load Balancer ID. By default, results are returned in ascending order by the creation date of each backend. The response is an array of backend objects, containing full details of each one including their configuration parameters such as protocol, port and forwarding algorithm." }, { "info": { "name": "Create a backend for a given Load Balancer", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lbs/:lb_id/backends", "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": "Create a new backend for a given Load Balancer, specifying its full configuration including protocol, port and forwarding algorithm." } ] }, { "info": { "name": "Certificate", "type": "folder" }, "items": [ { "info": { "name": "Get an SSL/TLS certificate", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/certificates/:certificate_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "certificate_id", "value": "", "type": "path", "description": "Certificate ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get information for a particular SSL/TLS certificate, specified by its certificate ID. The response returns full details of the certificate, including its type, main domain name, and alternative domain names." }, { "info": { "name": "Update an SSL/TLS certificate", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/lb/v1/zones/:zone/certificates/:certificate_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "certificate_id", "value": "", "type": "path", "description": "Certificate ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the name of a particular SSL/TLS certificate, specified by its certificate ID." }, { "info": { "name": "Delete an SSL/TLS certificate", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/lb/v1/zones/:zone/certificates/:certificate_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "certificate_id", "value": "", "type": "path", "description": "Certificate ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete an SSL/TLS certificate, specified by its certificate ID. Deleting a certificate is irreversible and cannot be undone." }, { "info": { "name": "List all SSL/TLS certificates on a given Load Balancer", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lbs/:lb_id/certificates", "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 certificates 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": "Number of certificates to return." }, { "name": "name", "value": "", "type": "query", "description": "Certificate name to filter for, only certificates of this name will be returned." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all the SSL/TLS certificates on a given Load Balancer. The response is an array of certificate objects, which are by default listed in ascending order of creation date." }, { "info": { "name": "Create an SSL/TLS certificate", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lbs/:lb_id/certificates", "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": "Generate a new SSL/TLS certificate for a given Load Balancer. You can choose to create a Let's Encrypt certificate, or import a custom certificate." } ] }, { "info": { "name": "Frontends", "type": "folder" }, "items": [ { "info": { "name": "Get a frontend", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/frontends/:frontend_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "frontend_id", "value": "", "type": "path", "description": "Frontend ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get the full details of a given frontend, specified by its frontend ID. The response contains the frontend's full configuration parameters including the backend it is attached to, the port it listens on, and any certificates it has." }, { "info": { "name": "Update a frontend", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/lb/v1/zones/:zone/frontends/:frontend_id", "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": "Update a given frontend, specified by its frontend ID. You can update configuration parameters including its name and the port it listens on. Note that the request type is PUT and not PATCH. You must set all parameters." }, { "info": { "name": "Delete a frontend", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/lb/v1/zones/:zone/frontends/:frontend_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "frontend_id", "value": "", "type": "path", "description": "ID of the frontend to delete." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete a given frontend, specified by its frontend ID. This action is irreversible and cannot be undone." }, { "info": { "name": "List frontends of a given Load Balancer", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lbs/:lb_id/frontends", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "lb_id", "value": "", "type": "path", "description": "Load Balancer ID." }, { "name": "name", "value": "", "type": "query", "description": "Name of the frontend to filter for." }, { "name": "order_by", "value": "", "type": "query", "description": "Sort order of frontends 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": "Number of frontends to return." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all the frontends of a Load Balancer, specified by its Load Balancer ID. By default, results are returned in ascending order by the creation date of each frontend. The response is an array of frontend objects, containing full details of each one including the port they listen on and the backend they are attached to." }, { "info": { "name": "Create a frontend in a given Load Balancer", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lbs/:lb_id/frontends", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "lb_id", "value": "", "type": "path", "description": "Load Balancer ID (ID of the Load Balancer to attach the frontend to)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Create a new frontend for a given Load Balancer, specifying its configuration including the port it should listen on and the backend to attach it to." } ] }, { "info": { "name": "IP addresses", "type": "folder" }, "items": [ { "info": { "name": "List IP addresses", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/ips", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "page", "value": "", "type": "query", "description": "The page number to return, from the paginated results." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of IP addresses to return." }, { "name": "ip_address", "value": "", "type": "query", "description": "IP address to filter for." }, { "name": "organization_id", "value": "", "type": "query", "description": "Organization ID to filter for, only Load Balancer IP addresses from this Organization will be returned." }, { "name": "project_id", "value": "", "type": "query", "description": "Project ID to filter for, only Load Balancer IP addresses from this Project will be returned." }, { "name": "ip_type", "value": "", "type": "query", "description": "IP type to filter for." }, { "name": "tags", "value": "", "type": "query", "description": "Tag to filter for, only IPs with one or more matching tags will be returned." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List the Load Balancer flexible IP addresses held in the account (filtered by Organization ID or Project ID). It is also possible to search for a specific IP address." }, { "info": { "name": "Create an IP address", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/lb/v1/zones/:zone/ips", "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 flexible IP address, in the specified Scaleway Project. This can be attached to new Load Balancers created in the future." }, { "info": { "name": "Get an IP address", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/ips/:ip_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "ip_id", "value": "", "type": "path", "description": "IP address ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve the full details of a Load Balancer flexible IP address." }, { "info": { "name": "Update an IP address", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.scaleway.com/lb/v1/zones/:zone/ips/:ip_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "ip_id", "value": "", "type": "path", "description": "IP address ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the reverse DNS of a Load Balancer flexible IP address." }, { "info": { "name": "Delete an IP address", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/lb/v1/zones/:zone/ips/:ip_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "ip_id", "value": "", "type": "path", "description": "IP address ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete a Load Balancer flexible IP address. This action is irreversible, and cannot be undone." } ] }, { "info": { "name": "Load Balancer Types", "type": "folder" }, "items": [ { "info": { "name": "List all Load Balancer offer types", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lb-types", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "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 items to return." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all the different commercial Load Balancer types. The response includes an array of offer types, each with a name, description, and information about its stock availability." } ] }, { "info": { "name": "Alert Subscribers", "type": "folder" }, "items": [ { "info": { "name": "Subscribe a subscriber to alerts for a given Load Balancer", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lb/:lb_id/subscribe", "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": "Subscribe an existing subscriber to alerts for a given Load Balancer." }, { "info": { "name": "Unsubscribe a subscriber from alerts for a given Load Balancer", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lb/:lb_id/unsubscribe", "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": "Unsubscribe a subscriber from alerts for a given Load Balancer. The subscriber is not deleted, and can be resubscribed in the future if necessary." }, { "info": { "name": "Delete a subscriber", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lb/subscription/:subscriber_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "subscriber_id", "value": "", "type": "path", "description": "Subscriber ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete an existing subscriber, specified by its subscriber ID. Deleting a subscriber is permanent, and cannot be undone." }, { "info": { "name": "List all subscribers", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/subscribers", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "order_by", "value": "", "type": "query", "description": "Sort order of subscribers 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 items to return." }, { "name": "name", "value": "", "type": "query", "description": "Subscriber name to search for." }, { "name": "organization_id", "value": "", "type": "query", "description": "Filter subscribers by Organization ID." }, { "name": "project_id", "value": "", "type": "query", "description": "Filter subscribers by Project ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all subscribers to Load Balancer alerts. By default, returns all subscribers to Load Balancer alerts for the Organization associated with the authentication token used for the request." }, { "info": { "name": "Create a subscriber", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/lb/v1/zones/:zone/subscribers", "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 subscriber, either with an email configuration or a webhook configuration, for a specified Scaleway Project." }, { "info": { "name": "Get a subscriber", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/subscribers/:subscriber_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "subscriber_id", "value": "", "type": "path", "description": "Subscriber ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve information about an existing subscriber, specified by its subscriber ID. Its full details, including name and email/webhook configuration, are returned in the response object." }, { "info": { "name": "Update a subscriber", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/lb/v1/zones/:zone/subscribers/:subscriber_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "subscriber_id", "value": "", "type": "path", "description": "Subscriber ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the parameters of a given subscriber (e.g. name, webhook configuration, email configuration), specified by its subscriber ID." } ] }, { "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." } ] }, { "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": "Stats", "type": "folder" }, "items": [ { "info": { "name": "Get usage statistics of a given Load Balancer", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/lbs/:lb_id/stats", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "lb_id", "value": "", "type": "path", "description": "Load Balancer ID." }, { "name": "backend_id", "value": "", "type": "query", "description": "ID of the backend." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Get usage statistics of a given Load Balancer" } ] }, { "info": { "name": "Route", "type": "folder" }, "items": [ { "info": { "name": "List all routes", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/routes", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "order_by", "value": "", "type": "query", "description": "Sort order of routes in the response." }, { "name": "page_size", "value": "", "type": "query", "description": "The number of route objects to return." }, { "name": "page", "value": "", "type": "query", "description": "The page number to return, from the paginated results." }, { "name": "frontend_id", "value": "", "type": "query", "description": "Frontend ID to filter for, only Routes from this Frontend will be returned." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "List all routes for a given frontend. The response is an array of routes, each one with a specified backend to direct to if a certain condition is matched (based on the value of the SNI field or HTTP Host header)." }, { "info": { "name": "Create a route", "type": "http" }, "http": { "method": "POST", "url": "https://api.scaleway.com/lb/v1/zones/:zone/routes", "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 route on a given frontend. To configure a route, specify the backend to direct to if a certain condition is matched (based on the value of the SNI field or HTTP Host header)." }, { "info": { "name": "Get a route", "type": "http" }, "http": { "method": "GET", "url": "https://api.scaleway.com/lb/v1/zones/:zone/routes/:route_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "route_id", "value": "", "type": "path", "description": "Route ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Retrieve information about an existing route, specified by its route ID. Its full details, origin frontend, target backend and match condition, are returned in the response object." }, { "info": { "name": "Update a route", "type": "http" }, "http": { "method": "PUT", "url": "https://api.scaleway.com/lb/v1/zones/:zone/routes/:route_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "route_id", "value": "", "type": "path", "description": "Route ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Update the configuration of an existing route, specified by its route ID." }, { "info": { "name": "Delete a route", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.scaleway.com/lb/v1/zones/:zone/routes/:route_id", "params": [ { "name": "zone", "value": "", "type": "path", "description": "The zone you want to target" }, { "name": "route_id", "value": "", "type": "path", "description": "Route ID." } ], "auth": { "type": "apikey", "key": "X-Auth-Token", "value": "{{X-Auth-Token}}", "placement": "header" } }, "docs": "Delete an existing route, specified by its route ID. Deleting a route is permanent, and cannot be undone." } ] } ], "bundled": true }