> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gcore.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get load balancer pool health monitor

> Returns the health monitor configured for a load balancer pool, including its type,
check intervals, timeouts, and the thresholds used to mark pool members as healthy or
unhealthy. Returns 404 if the pool has no health monitor attached.



## OpenAPI

````yaml /api-reference/services_docs_mintlify_enriched/cloud_api.yaml get /cloud/v1/lbpools/{project_id}/{region_id}/{pool_id}/healthmonitor
openapi: 3.1.0
info:
  title: Gcore OpenAPI – Cloud API
  description: >-
    This OpenAPI is an aggregated OpenAPI specification that unifies all Gcore
    products into a single file. It covers Cloud, CDN, DNS, WAAP, DDoS
    Protection, Object Storage, Streaming, and FastEdge services.
  version: e4facaa17275
servers:
  - url: https://api.gcore.com
security:
  - APIKey: []
tags:
  - name: Bare Metal
  - name: Container as a Service
  - name: Cost Reports
  - name: DDoS Protection
  - name: Everywhere Inference
  - name: Everywhere Inference Apps
  - name: File Shares
  - name: Floating IPs
  - name: Function as a Service
  - name: GPU Bare Metal
  - name: GPU Virtual
  - name: IP Ranges
  - name: Images
  - name: Instances
  - name: Load Balancers
  - name: Logging
  - name: Managed Kubernetes
  - name: Managed PostgreSQL
  - name: Networks
  - name: Placement Groups
  - name: Ports
  - name: Projects
  - name: Quotas
  - name: Regions
  - name: Registry
  - name: Reservations
  - name: Reserved IPs
  - name: Routers
  - name: SSH Keys
  - name: Secrets
  - name: Security Groups
  - name: Snapshot Schedules
  - name: Snapshots
  - name: Tasks
  - name: User Actions
  - name: User Role Assignments
  - name: Volumes
paths:
  /cloud/v1/lbpools/{project_id}/{region_id}/{pool_id}/healthmonitor:
    get:
      tags:
        - Load Balancers
      summary: Get load balancer pool health monitor
      description: >-
        Returns the health monitor configured for a load balancer pool,
        including its type,

        check intervals, timeouts, and the thresholds used to mark pool members
        as healthy or

        unhealthy. Returns 404 if the pool has no health monitor attached.
      operationId: LoadBalancerPoolInstanceHealthMonitorViewSet.get
      parameters:
        - in: path
          name: project_id
          required: true
          description: Project ID
          schema:
            description: Project ID
            example: 1
            examples:
              - 1
            title: Project Id
            type: integer
        - in: path
          name: region_id
          required: true
          description: Region ID
          schema:
            description: Region ID
            example: 1
            examples:
              - 1
            exclusiveMinimum: 0
            title: Region Id
            type: integer
        - in: path
          name: pool_id
          required: true
          description: Pool ID
          schema:
            description: Pool ID
            example: 00000000-0000-4000-8000-000000000000
            examples:
              - 00000000-0000-4000-8000-000000000000
            format: uuid4
            title: Pool Id
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LbHealthMonitorSerializer'
components:
  schemas:
    LbHealthMonitorSerializer:
      properties:
        admin_state_up:
          description: >-
            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
          examples:
            - false
          title: Admin State Up
          type: boolean
        delay:
          description: The time, in seconds, between sending probes to members
          example: 10
          examples:
            - 10
          maximum: 2147483647
          minimum: 1
          title: Delay
          type: integer
        domain_name:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Domain name for HTTP host header. Can only be used together with
            `HTTP` or `HTTPS` health monitor type.
          examples:
            - example.com
          title: Domain Name
        expected_codes:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            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.
          examples:
            - 200,301,302
          title: Expected Codes
        http_method:
          anyOf:
            - $ref: '#/components/schemas/HttpMethodEnum'
            - type: 'null'
          description: HTTP method
          examples:
            - GET
        http_version:
          anyOf:
            - enum:
                - '1.0'
                - '1.1'
              type: string
            - type: 'null'
          description: >-
            HTTP version. Can only be used together with `HTTP` or `HTTPS`
            health monitor type.
          examples:
            - '1.1'
            - '1.0'
          title: Http Version
        id:
          description: Health monitor ID
          example: 2eb5823b-9cdc-45cd-97c0-c95cc2278422
          examples:
            - 2eb5823b-9cdc-45cd-97c0-c95cc2278422
          format: uuid4
          title: Id
          type: string
        max_retries:
          description: Number of successes before the member is switched to ONLINE state
          example: 2
          examples:
            - 2
          maximum: 10
          minimum: 1
          title: Max Retries
          type: integer
        max_retries_down:
          description: Number of failures before the member is switched to ERROR state
          example: 3
          examples:
            - 3
          maximum: 10
          minimum: 1
          title: Max Retries Down
          type: integer
        operating_status:
          $ref: '#/components/schemas/OperatingStatusEnum'
          description: Health Monitor operating status
          examples:
            - ONLINE
            - DRAINING
            - OFFLINE
            - DEGRADED
            - ERROR
            - NO_MONITOR
        provisioning_status:
          $ref: '#/components/schemas/ProvisioningStatusEnum'
          description: Health monitor lifecycle status
          examples:
            - ACTIVE
        timeout:
          description: The maximum time to connect. Must be less than the delay value
          example: 5
          examples:
            - 5
          maximum: 2147483
          minimum: 0
          title: Timeout
          type: integer
        type:
          $ref: '#/components/schemas/HealthMonitorTypeEnum'
          description: >-
            Health monitor type. Once health monitor is created, cannot be
            changed.
          examples:
            - HTTP
        url_path:
          anyOf:
            - minLength: 1
              type: string
            - type: 'null'
          description: URL Path. Defaults to '/'
          examples:
            - /
          title: Url Path
      required:
        - delay
        - max_retries
        - timeout
        - id
        - type
        - max_retries_down
        - http_method
        - url_path
        - expected_codes
        - operating_status
        - provisioning_status
        - admin_state_up
        - http_version
        - domain_name
      title: LbHealthMonitorSerializer
      type: object
    HttpMethodEnum:
      enum:
        - CONNECT
        - DELETE
        - GET
        - HEAD
        - OPTIONS
        - PATCH
        - POST
        - PUT
        - TRACE
      title: HttpMethodEnum
      type: string
    OperatingStatusEnum:
      enum:
        - DEGRADED
        - DRAINING
        - ERROR
        - NO_MONITOR
        - OFFLINE
        - ONLINE
      title: OperatingStatusEnum
      type: string
    ProvisioningStatusEnum:
      enum:
        - ACTIVE
        - DELETED
        - ERROR
        - PENDING_CREATE
        - PENDING_DELETE
        - PENDING_UPDATE
      title: ProvisioningStatusEnum
      type: string
    HealthMonitorTypeEnum:
      enum:
        - HTTP
        - HTTPS
        - K8S
        - PING
        - TCP
        - TLS-HELLO
        - UDP-CONNECT
      title: HealthMonitorTypeEnum
      type: string
  securitySchemes:
    APIKey:
      description: >-
        API key for authentication. Make sure to include the word `apikey`,
        followed by a single space and then your token.

        Example: `apikey 1234_abcdef`
      type: apiKey
      in: header
      name: Authorization

````