Load Balancer API

Layer-7 load balancers and backends

REST API endpoints for Load Balancer. 6 operations.

List load balancers

GET /v1/lb

Returns all load balancers belonging to the caller's project.

Auth: Bearer API key

Responses

operationId: listLoadBalancers

Create a load balancer

POST /v1/lb

Provisions a load balancer for the caller's project and returns its details.

Auth: Bearer API key

Request body

application/json (required) — schema CreateLbRequest.

Responses

operationId: createLoadBalancer

Delete a load balancer

DELETE /v1/lb/{id}

Removes a load balancer and its backends by id.

Auth: Bearer API key

Parameters

Responses

operationId: deleteLoadBalancer

Get a load balancer

GET /v1/lb/{id}

Returns a single load balancer by id.

Auth: Bearer API key

Parameters

Responses

operationId: getLoadBalancer

Add a backend to a load balancer

POST /v1/lb/{id}/backends

Registers a backend target on the load balancer and returns its details.

Auth: Bearer API key

Parameters

Request body

application/json (required) — schema AddBackendRequest.

Responses

operationId: addLoadBalancerBackend

Remove a backend from a load balancer

DELETE /v1/lb/{id}/backends/{backend_id}

Deletes a backend target from the load balancer by id.

Auth: Bearer API key

Parameters

Responses

operationId: removeLoadBalancerBackend