Load Balancers

Get Load Balancers

get

Get all Load Balancers in a configuration

Path parameters
configstringrequired
Responses
curl -L \
  --url '/api/v4.0/conf/{config}/load-balancers'
{
  "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.

Available options:
regionstringrequired
defaultbooleanoptionalDefault: false
elbv2booleanoptionalDefault: true
listenerstringrequired
listener-portintegerrequired
Responses
curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/load-balancers/{entry_name}/certificates/{certificate_id}?provider=aws&region=text&listener=text&listener-port=1'

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
curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/load-balancers/{entry_name}/certificates?provider=text&region=text'

No Content

Last updated

Was this helpful?