{
  "opencollection": "1.0.0",
  "info": {
    "name": "Managed Database for PostgreSQL and MySQL Access Control List Backends API",
    "version": "v1"
  },
  "items": [
    {
      "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."
        }
      ]
    }
  ],
  "bundled": true
}