Load Balancers

PreviousGlobal Filters NextLog Exporters

Last updated 5 months ago

Was this helpful?

Get Load Balancers

Get all Load Balancers in a configuration

get

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

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/load-balancers'

200

400

500

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

Load Balancers retrieved successfully

Add Certificate

Add a certificate to a Load Balancer

put

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

Path parameters

configConfigrequired

entry_nameLoad Balancer Namerequired

certificate_idCertificate IDrequired

Query parameters

providerCloudProviderEnumrequired

An enumeration.

Options: aws, gcp

regionRegionrequired

defaultDefault

elbv2ELB v2

listenerListenerrequired

listener-portListener Portrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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'

200

422

500

No body

Successfully added certificate to Load Balancer

Detach certificate

Detach a non-default certificate from the Load Balancer

delete

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

Path parameters

configConfigrequired

entry_nameLoad Balancer Namerequired

Query parameters

providerProviderrequired

regionRegionrequired

certificate-idCertificate ID

elbv2ELB v2

listenerListener

listener-portListener Port

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/load-balancers/{entry_name}/certificates?provider=text&region=text'

200

422

500

No body

Successfully detached certificate from Load Balancer