Skip to navigation

Get a load balancer

Returns one load balancer with its specification, observed_state and conditions. Requires scope: load-balancer.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# LOAD_BALANCER_ID: The load balancer's ID
curl "https://api.ibee.ai/v1/networking/load-balancers/$LOAD_BALANCER_ID?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN"

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Path parameters

load_balancer_idstringRequiredformat: "uuid"
The load balancer's ID.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

Response

Success.
idstringformat: "uuid"
namestring
region_idstringformat: "uuid"
vpc_idstring or null
scopestring
traffic_typestring
capacity_modestring
visibilitystring
node_countinteger
managed_bystring

ccm when a Kubernetes cluster made it: such load balancers are read-only here.

specobject
desired_statestring
observed_statestring
conditionsmap from strings to any
generationinteger
observed_generationinteger
versioninteger
created_atdatetime
updated_atdatetime
deleted_atdatetime or nullOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
413
Content Too Large Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error