Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
Load Balancers

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

Path parameters

project_idinteger required

Project ID

Example:1

Project ID

region_idinteger required

Region ID

Example:1

Region ID

pool_idstring uuid4 required

Pool ID

Example:00000000-0000-4000-8000-000000000000

Pool ID

Request body

admin_state_upboolean

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.

delayinteger required

The time, in seconds, between sending probes to members

domain_namestring nullable

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

expected_codesstring nullable

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.

http_method'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE'
http_version'1.0' | '1.1' nullable

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

max_retriesinteger required

Number of successes before the member is switched to ONLINE state

max_retries_downinteger

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

timeoutinteger required

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

type'HTTP' | 'HTTPS' | 'K8S' | 'PING' | 'TCP' | 'TLS-HELLO' | 'UDP-CONNECT' required
url_pathstring nullable

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

Example request

{
  "admin_state_up": true,
  "delay": 10,
  "domain_name": "example.com",
  "expected_codes": "200,301,302",
  "http_version": "1.1",
  "max_retries": 2,
  "max_retries_down": 2,
  "timeout": 5,
  "url_path": "/"
}

Response

OK

tasksstring[] 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.
idstring required

Example response

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