Load Balancers

Get Load Balancers

Get all Load Balancers in a configuration

GET/api/v4.0/conf/{config}/load-balancers

Path parameters

config*Config

Response

200400500

Load Balancers retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of LoadBalancer

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/load-balancers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

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

Add Certificate

Add a certificate to a Load Balancer

PUT/api/v4.0/conf/{config}/load-balancers/{entry_name}/certificates/{certificate_id}

Path parameters

config*Config

entry_name*Load Balancer Name

certificate_id*Certificate ID

Query parameters

Response

200422500

Successfully added certificate to Load Balancer

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/load-balancers/{entry_name}/certificates/{certificate_id}?provider=aws&region=text&listener=text', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

422500

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Detach certificate

Detach a non-default certificate from the Load Balancer

DELETE/api/v4.0/conf/{config}/load-balancers/{entry_name}/certificates

Path parameters

config*Config

entry_name*Load Balancer Name

Query parameters

Response

200422500

Successfully detached certificate from Load Balancer

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/load-balancers/{entry_name}/certificates?provider=text&region=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

422500

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}