Create load balancer pool health monitor

Creates a health monitor for a load balancer pool to automatically check the health status of pool members. The health monitor performs periodic checks on pool members and removes unhealthy members from rotation, ensuring only healthy servers receive traffic.

POST /cloud/v1/lbpools/{project_id}/{region_id}/{pool_id}/healthmonitor

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
task_id_list = client.cloud.load_balancers.pools.health_monitors.create(
    pool_id="00000000-0000-4000-8000-000000000000",
    project_id=1,
    region_id=1,
    delay=10,
    max_retries=2,
    api_timeout=5,
    type="HTTP",
)
print(task_id_list.tasks)

200

{
  "tasks": [
    "d478ae29-dedc-4869-82f0-96104425f565"
  ]
}

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"

Body

application/json

delay · integer · required

The time, in seconds, between sending probes to members

Required range: 1 <= x <= 2147483647

Example:

10

max_retries · integer · required

Number of successes before the member is switched to ONLINE state

Required range: 1 <= x <= 10

Example:

2

timeout · integer · required

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

Required range: 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

Examples:

"HTTP"

"HTTPS"

"PING"

"TCP"

"TLS_HELLO"

"UDP_CONNECT"

"K8S"

admin_state_up · boolean

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.

Examples:

true

false

domain_name · string | null

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

Pattern: ^[A-Za-z0-9._-]{1,253}$

Example:

"example.com"

expected_codes · string | null

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

Example:

"200,301,302"

http_method · enum<string> | null

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

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

Example:

"CONNECT"

http_version · enum<string> | null

HTTP version. Can only be used together with HTTP or HTTPS health monitor type. Supported values: 1.0, 1.1.

Available options: 1.0, 1.1

Example:

"1.1"

max_retries_down · integer

Number of failures before the member is switched to ERROR state.

Required range: 1 <= x <= 10

Example:

2

url_path · string | null

The HTTP path the health monitor requests on each member. Defaults to / if not set. Can only be used with HTTP or HTTPS health monitor type.

Must start with / and contain only plain path segments. Query strings (?), fragments (#), percent-encoding (%), and consecutive slashes (//) are not allowed.

Examples of valid paths:

• / — check the root (most common, default)
• /healthz — a dedicated health endpoint

Pattern: ^/([^/?#%][^?#%]*)?$

Example:

"/"

Response

200 - application/json

OK

tasks · string[] · required

List of task IDs representing asynchronous operations. Use these IDs to monitor operation progress:

• GET /v1/tasks/{task_id} - Check individual task status and details Poll task status until completion (FINISHED/ERROR) before proceeding with dependent operations.

Example:

["d478ae29-dedc-4869-82f0-96104425f565"]