How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HAProxy Health Check API

The Health Check API from HAProxy — 2 operation(s) for health check.

HAProxy Health Check API is one of 68 APIs that HAProxy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Health Check. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, a GitHub repository, and a changelog.

This API exposes 5 operations across 2 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 3.4.

Requests are made against a single base URL, /v3.

5 operations 2 paths 13 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.4
Base URL
http://{haproxy-host}:5555/v3/services/haproxy/runtime
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

HAProxy Health Check API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basic_auth). By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Health Check 5
GET
/services/haproxy/configuration/healthchecks
Return an array of healthchecks
getHealthChecks 2 params → 200default
POST
/services/haproxy/configuration/healthchecks
Add a healthcheck
createHealthCheck 4 params body → 201202400409default
DELETE
/services/haproxy/configuration/healthchecks/{name}
Delete a healthcheck
deleteHealthCheck 4 params → 202204404default
GET
/services/haproxy/configuration/healthchecks/{name}
Return a healthcheck
getHealthCheck 3 params → 200404default
PUT
/services/haproxy/configuration/healthchecks/{name}
Replace a healthcheck
replaceHealthCheck 5 params body → 200202400404default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are http_check (35 properties), tcp_check (32 properties), healthcheck_base (6 properties), httpchk_params (4 properties). Each schema is shown below with its type and property counts.

httpchk_params
object
4 properties
pgsql_check_params
object
1 property
http_checks
array
error
object
API Error
2 properties 2 required
return_header
object
2 properties 2 required
mysql_check_params
object
2 properties
healthchecks
array
HAProxy healthchecks array
http_check
object
35 properties 1 required
tcp_checks
array
smtpchk_params
object
2 properties
healthcheck
object
HealthCheck with all it's children resources
healthcheck_base
object
HealthCheck with all it's children resources
6 properties 1 required
tcp_check
object
32 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

haproxy-health-check-api-openapi.yml Raw ↑

Other APIs HAProxy publishes across the network.

HAProxy Runtime API
HAProxy Kubernetes Ingress Controller
HAProxy ACL API
HAProxy ACL Runtime API
HAProxy Acme API
HAProxy Acme Runtime API
HAProxy Backend API
HAProxy Backend Switching Rule API
HAProxy Bind API
HAProxy Cache API
HAProxy Configuration API
HAProxy Crt Load API
Where this information came from

This is an independent, third-party profile of HAProxy Health Check API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.