List Load Balancers

GET/v1/load_balancers

A GET request to the /v1/load_balancers endpoint shows a list of Load Balancers.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

FieldDetails
search_pattern?
string

This pattern is used to return resources containing the parameter value in its name.

label_selector?
string

This parameter will filter results by labels. More details in the Labels section.

location_id?
integer

Min: 1

A unique identifier of a location. A request to list IDs is described in the Location block.

cluster_id?
string

A unique identifier of a dedicated Load Balancer cluster.

type?
string

Value in: "l4", "l7"

This parameter selects an L4 or L7 balancer to return in an output.

network_type?
string

Value in: "public", "private"

This parameter selects a public or private balancer to return in an output.

per_page?
integer

Default: 20

Range: 1–100

The number of results [ 1 .. 100 ] displayed on a page. By default, 20 results are shown.

page?
integer

Default: 1

Min: 1

The number of a page (>= 1) that will be returned. By default, it's 1.

sorting?
string

Value in: "id", "created_at", "updated_at"

Default: "id"

This parameter sorts items. By default, it's id.

direction?
string

Value in: "ASC", "DESC"

Default: "ASC"

This parameter defines if items are sorted in an ascending ASC or descending DESC order. By default, ASC is set up

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/load_balancers"
[  {    "id": "YQdJ2dOG",    "name": "name1497",    "type": "l7",    "status": "pending",    "network_type": "public",    "external_addresses": [],    "internal_addresses": [],    "location_id": 1569,    "location_code": "location3242",    "labels": {      "environment": "production",      "service": "my-web-app",      "example.com/project": "my-project",      "example.com/owner": "my-team"    },    "cluster_id": null,    "created_at": "2025-12-31T00:00:00Z",    "updated_at": "2025-12-31T00:00:00Z"  },  {    "id": "y1aKReQG",    "name": "name1498",    "type": "l7",    "status": "pending",    "network_type": "public",    "external_addresses": [      "101.0.0.19"    ],    "internal_addresses": [],    "location_id": 1569,    "location_code": "location3242",    "labels": {      "environment": "production",      "service": "my-web-app",      "example.com/project": "my-project",      "example.com/owner": "my-team"    },    "cluster_id": null,    "created_at": "2025-12-31T00:00:00Z",    "updated_at": "2025-12-31T00:00:00Z"  },  {    "id": "9wdLwbjP",    "name": "name1499",    "type": "l7",    "status": "pending",    "network_type": "public",    "external_addresses": [],    "internal_addresses": [],    "location_id": 1569,    "location_code": "location3242",    "labels": {      "environment": "production",      "service": "my-web-app",      "example.com/project": "my-project",      "example.com/owner": "my-team"    },    "cluster_id": null,    "created_at": "2025-12-31T00:00:00Z",    "updated_at": "2025-12-31T00:00:00Z"  }]