Load Balancers

Get Load Balancers

get

Get all Load Balancers in a configuration

Path parameters

configstringRequired

Responses

200

Load Balancers retrieved successfully

application/json

400

Input Error

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/v4.0/conf/{config}/load-balancers HTTP/1.1
Host: 
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

422

Validation Error

application/json

500

Internal Server Error

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v4.0/conf/{config}/load-balancers/{entry_name}/certificates/{certificate_id}?provider=aws&region=text&listener=text&listener-port=1 HTTP/1.1
Host: 
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

422

Validation Error

application/json

500

Internal Server Error

application/json

delete

HTTPcURLJavaScriptPython

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

No content