Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Load Balancers

Prerequisites

The {config} API parameter is discussed here.

Load balancer administration is discussed here. The discussion below assumes familiarity with it.

Special considerations when using the API

Multi-regional configuration

As explained here, when a Link11 load balancer supports a multi-regional planet, admins can (if desired) configure traffic routing.

The API provides additional granularity beyond the configuration available in the web console:

  • In the UI, the load balancer is treated as a single instance. However, this "one" load balancer is conceptual: it represents multiple physical instances, running simultaneously in different cities. The API provides the ability to configure each city separately, if desired.

  • In the UI, the Preferred datacenter control displays a list of datacenters where Link11 WAAP has been deployed. In the API, this list is provided in the upstream_regions parameter, which is returned when calling GET /api/v4.3/conf/{config}/load-balancers/regions.

  • In the UI, one Preferred datacenter can be selected, which will be applied to all cities. In the API, different datacenters can be specified for different cities, by calling POST /api/v4.3/conf/{config}/load-balancers/regions.

When calling POST /api/v4.3/conf/{config}/load-balancers/regions, all desired preferences should be specified. All unspecified regions will be set to the default preference of automatic .

If an incorrect preferred datacenter (one where L11WAAP is not running) is specified, this action will be rejected, and the previous selection will remain in effect.

API overview

Action
Operation

To retrieve information about all load balancers

GET .../load-balancers

To add a certificate

PUT .../{entry_name}/certificates/{certificate_id}

To remove a certificate

DELETE .../{entry_name}/certificates

To get the list of Link11 WAAP datacenters, and each city's current preference

GET .../regions

To set preferred datacenters for each city

POST .../regions

Operations

Get Load Balancers

get

Get all Load Balancers in a configuration

Path parameters
configstringRequired
Responses
200

Load Balancers retrieved successfully

application/json
totalintegerOptionalExample: 1
get/api/v4.3/conf/{config}/load-balancers
GET /api/v4.3/conf/{config}/load-balancers HTTP/1.1
Accept: */*

{
  "total": 1,
  "items": [
    {
      "certificates": [
        "text"
      ],
      "default_certificate": "text",
      "dns_name": "text",
      "listener_name": "text",
      "listener_port": 1,
      "load_balancer_type": "classic",
      "max_certificates": 1,
      "name": "text",
      "provider": "aws",
      "region": "text"
    }
  ]
}

Add Certificate

put

Add a certificate to a Load Balancer

Path parameters
configstringRequired
entry_namestringRequired
certificate_idstringRequired
Query parameters
providerstring · enumRequired

An enumeration.

Possible values:
regionstringRequired
defaultbooleanOptionalDefault: false
elbv2booleanOptionalDefault: true
listenerstringRequired
listener-portintegerRequired
Responses
200

Successfully added certificate to Load Balancer

No content
put/api/v4.3/conf/{config}/load-balancers/{entry_name}/certificates/{certificate_id}
PUT /api/v4.3/conf/{config}/load-balancers/{entry_name}/certificates/{certificate_id}?provider=aws&region=text&listener=text&listener-port=1 HTTP/1.1
Accept: */*

No content

Detach certificate

delete

Detach a non-default certificate from the Load Balancer

Path parameters
configstringRequired
entry_namestringRequired
Query parameters
providerstringRequired
regionstringRequired
certificate-idstringOptional
elbv2booleanOptionalDefault: true
listenerstringOptional
listener-portstringOptional
Responses
200

Successfully detached certificate from Load Balancer

No content
delete/api/v4.3/conf/{config}/load-balancers/{entry_name}/certificates
DELETE /api/v4.3/conf/{config}/load-balancers/{entry_name}/certificates?provider=text&region=text HTTP/1.1
Accept: */*

No content

Get available datacenters per region and Load Balancer

get

Get regions with available datacenters for each Load Balancer.

Path parameters
configstringRequired
Responses
200

Load Balancers retrieved successfully

application/json
city_codesobject · City NamesOptionalExample: {"ams":"Amsterdam","ash":"Ashburn","ffm":"Frankfurt","hkg":"Hong Kong","lax":"Los Angeles","lon":"London","sgp":"Singapore","stl":"Saint Louis"}
get/api/v4.3/conf/{config}/load-balancers/regions
GET /api/v4.3/conf/{config}/load-balancers/regions HTTP/1.1
Accept: */*

{
  "city_codes": "{\"ams\":\"Amsterdam\",\"ash\":\"Ashburn\",\"ffm\":\"Frankfurt\",\"hkg\":\"Hong Kong\",\"lax\":\"Los Angeles\",\"lon\":\"London\",\"sgp\":\"Singapore\",\"stl\":\"Saint Louis\"}\n",
  "lbs": "[{\"id\":\"<id>\",\"name\":\"<name>\",\"regions\":{\"ams\":\"automatic\",\"ash\":\"automatic\",\"ffm\":\"automatic\",\"hkg\":\"automatic\",\"lax\":\"automatic\",\"lon\":\"automatic\",\"sgp\":\"automatic\",\"stl\":\"automatic\"},\"upstream_regions\":[\"ffm\",\"lax\"]}]\n"
}

Set preferred datacenters for each Load Balancer

post

Set preferred datacenters for each Load Balancer. "automatic" will choose the best route depending on the load balancer location.

Path parameters
configstringRequired
Body
lbsobject · LoadBalancer Region to Datacenter Region[]RequiredExample: [{"id":"<id>","regions":{"ash":"ffm","ffm":"ffm","hkg":"ffm","lax":"ffm","lon":"ffm","sgp":"ffm","stl":"automatic"}}]
Responses
200

Load Balancers retrieved successfully

application/json
messagestringOptionalExample: Successfully set Load Balancer regions
post/api/v4.3/conf/{config}/load-balancers/regions
POST /api/v4.3/conf/{config}/load-balancers/regions HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "lbs": "[{\"id\":\"<id>\",\"regions\":{\"ash\":\"ffm\",\"ffm\":\"ffm\",\"hkg\":\"ffm\",\"lax\":\"ffm\",\"lon\":\"ffm\",\"sgp\":\"ffm\",\"stl\":\"automatic\"}}]\n"
}
{
  "message": "Successfully set Load Balancer regions"
}
PreviousGlobal Filters
NextLog Exporters

Last updated

Was this helpful?