Get a load balancer

GET

/networking/load-balancers/:load_balancer_id

GET

/v1/networking/load-balancers/:load_balancer_id

$ curl -G https://api.ibee.ai/v1/networking/load-balancers/load_balancer_id \
>      -H "Authorization: Bearer <token>" \
>      -d workspace_id=710995

1 {
2   "lb_id": "string",
3   "organization_id": "string",
4   "workspace_id": "string",
5   "name": "string",
6   "layer": "l4",
7   "protocol": "http",
8   "status": "provisioning",
9   "endpoint": {
10     "host": "string",
11     "port": 1
12   },
13   "url": "string",
14   "endpoint_url": "string",
15   "backends": [
16     {
17       "target": "string",
18       "port": 1,
19       "type": "service",
20       "weight": 100,
21       "tls": false
22     }
23   ],
24   "created_at": "2024-01-15T09:30:00Z",
25   "updated_at": "2024-01-15T09:30:00Z",
26   "workspace_name": "string",
27   "namespace": "string",
28   "rules": [
29     {
30       "priority": 1,
31       "path_prefix": "/",
32       "headers": {},
33       "backends": [
34         {
35           "target": "string",
36           "port": 1,
37           "type": "service",
38           "weight": 100,
39           "tls": false
40         }
41       ]
42     }
43   ]
44 }

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_idstringRequired

Load balancer 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

Load balancer returned successfully.

lb_idstring

organization_idstring

workspace_idstring

namestring

layerenum

protocolenum

statusenum

endpointobject

urlstring

endpoint_urlstring

backendslist of objects

created_atdatetime

updated_atdatetime

workspace_namestringOptional

namespacestringOptional

ruleslist of objects or nullOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error