Skip to main content
GET
Get load balancer pool health monitor

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

pool_id
string<uuid4>
required

Pool ID

Example:

"00000000-0000-4000-8000-000000000000"

Response

200 - application/json

OK

admin_state_up
boolean
required

Administrative state of the resource. When set to true, the resource is enabled and operational. When set to false, the resource is disabled and will not process traffic. Defaults to true.

Example:

false

delay
integer
required

The time, in seconds, between sending probes to members

Required range: 1 <= x <= 2147483647
Example:

10

domain_name
string | null
required

Domain name for HTTP host header. Can only be used together with HTTP or HTTPS health monitor type.

Example:

"example.com"

expected_codes
string | null
required

Expected HTTP response codes. Can be a single code, a comma-separated list of codes, or a single range of codes. Can only be used together with HTTP or HTTPS health monitor type. For example, 200, 200,202,401,403,404, or 200-204. If not specified, the default is 200.

Example:

"200,301,302"

http_method
enum<string> | null
required

HTTP method

Available options:
CONNECT,
DELETE,
GET,
HEAD,
OPTIONS,
PATCH,
POST,
PUT,
TRACE
Example:

"GET"

http_version
enum<string> | null
required

HTTP version. Can only be used together with HTTP or HTTPS health monitor type.

Available options:
1.0,
1.1
Example:

"1.1"

id
string<uuid4>
required

Health monitor ID

Example:

"2eb5823b-9cdc-45cd-97c0-c95cc2278422"

max_retries
integer
required

Number of successes before the member is switched to ONLINE state

Required range: 1 <= x <= 10
Example:

2

max_retries_down
integer
required

Number of failures before the member is switched to ERROR state

Required range: 1 <= x <= 10
Example:

3

operating_status
enum<string>
required

Health Monitor operating status

Available options:
DEGRADED,
DRAINING,
ERROR,
NO_MONITOR,
OFFLINE,
ONLINE
Examples:

"ONLINE"

"DRAINING"

"OFFLINE"

"DEGRADED"

"ERROR"

"NO_MONITOR"

provisioning_status
enum<string>
required

Health monitor lifecycle status

Available options:
ACTIVE,
DELETED,
ERROR,
PENDING_CREATE,
PENDING_DELETE,
PENDING_UPDATE
Example:

"ACTIVE"

timeout
integer
required

The maximum time to connect. Must be less than the delay value

Required range: 0 <= x <= 2147483
Example:

5

type
enum<string>
required

Health monitor type. Once health monitor is created, cannot be changed.

Available options:
HTTP,
HTTPS,
K8S,
PING,
TCP,
TLS-HELLO,
UDP-CONNECT
Example:

"HTTP"

url_path
string | null
required

URL Path. Defaults to '/'

Minimum string length: 1
Example:

"/"