HAProxy

HAProxy Health API

The Health API from HAProxy — 1 operation(s) for health.

GitHub OpenAPI

Operations 1

GET /health Return managed services health #

Documentation

📖
Documentation
https://www.haproxy.com/documentation/haproxy-data-plane-api/
📖
APIReference
https://www.haproxy.com/documentation/haproxy-data-plane-api/reference/
📖
GettingStarted
https://www.haproxy.com/documentation/haproxy-data-plane-api/installation/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/haproxy/refs/heads/main/openapi/haproxy-health-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/haproxytech/dataplaneapi

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/haproxy/refs/heads/main/data-model/haproxy-data-model.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/haproxy/refs/heads/main/errors/haproxy-problem-types.yml
🔗
ChangeLog
https://github.com/haproxytech/dataplaneapi/releases

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/haproxy-health-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

haproxy-health-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: HAProxy Data Plane Health API
  description: 'API for editing and managing haproxy instances. Provides process information, configuration management,

    haproxy stats and logs.'
  version: '3.4'
  contact:
    name: HAProxy Support
    url: https://my.haproxy.com/portal/cust/login
    email: support@haproxy.com
servers:
- url: /v3
security:
- basic_auth: []
tags:
- name: Health
paths:
  /health:
    get:
      operationId: getHealth
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/health'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Return managed services health
      tags:
      - Health
components:
  schemas:
    error:
      additionalProperties:
        type: string
      description: API Error
      properties:
        code:
          type:
          - integer
          - 'null'
        message:
          type:
          - string
          - 'null'
      required:
      - code
      - message
      title: Error
      type: object
    health:
      properties:
        haproxy:
          enum:
          - up
          - down
          - unknown
          type: string
      type: object
  responses:
    DefaultError:
      description: General Error
      headers:
        Configuration-Version:
          description: Configuration file version
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
  securitySchemes:
    basic_auth:
      type: http
      scheme: basic
externalDocs:
  url: https://docs.haproxy.org/
  description: HAProxy Documentation