List load balancers

GET

/networking/load-balancers

GET

/v1/networking/load-balancers

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

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

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.

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.

statusenumOptional

Allowed values:

layerenumOptional

Allowed values:

protocolenumOptional

Allowed values:

limitintegerOptional1-500Defaults to 100

skipintegerOptional>=0Defaults to 0

Response

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