Skip to main content
GET
List load balancer pools

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id
integer
required

Project ID

Example:

1

region_id
integer
required

Region ID

Example:

1

Query Parameters

details
boolean
default:false

Show members and Health Monitor details

Examples:

true

false

limit
integer
default:1000

Optional. Limit the number of returned items

Required range: x <= 1000
Example:

1000

listener_id
string<uuid4>

Listener ID

Example:

"00000000-0000-4000-8000-000000000000"

load_balancer_id
string<uuid4>

Load Balancer ID

Example:

"00000000-0000-4000-8000-000000000000"

name
string

Filter by name

Example:

"lb-pool-name"

offset
integer
default:0

Optional. Offset value is used to exclude the first set of records from the result

Required range: x >= 0
Example:

0

Response

200 - application/json

OK

count
integer
required

Number of objects

Required range: x >= 0
Example:

1

results
LbPoolSerializer · object[]
required

Objects