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 HTTP Check API

The HTTPCheck API from HAProxy — 6 operation(s) for httpcheck.

HAProxy HTTP 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 HTTPCheck. 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 18 operations across 6 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 3.4.

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

18 operations 6 paths 4 schemas 3 DELETE6 GET3 POST6 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
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

HAProxy HTTP 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 18

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

HTTPCheck 18
GET
/services/haproxy/configuration/backends/{parent_name}/http_checks
Return an array of HTTP checks
getAllHTTPCheckBackend 2 params → 200default
PUT
/services/haproxy/configuration/backends/{parent_name}/http_checks
Replace an HTTP checks list
replaceAllHTTPCheckBackend 4 params body → 200202400default
GET
/services/haproxy/configuration/defaults/{parent_name}/http_checks
Return an array of HTTP checks
getAllHTTPCheckDefaults 2 params → 200default
PUT
/services/haproxy/configuration/defaults/{parent_name}/http_checks
Replace an HTTP checks list
replaceAllHTTPCheckDefaults 4 params body → 200202400default
GET
/services/haproxy/configuration/healthchecks/{parent_name}/http_checks
Return an array of HTTP checks
getAllHTTPCheckHealthcheck 2 params → 200default
PUT
/services/haproxy/configuration/healthchecks/{parent_name}/http_checks
Replace an HTTP checks list
replaceAllHTTPCheckHealthcheck 4 params body → 200202400default
DELETE
/services/haproxy/configuration/backends/{parent_name}/http_checks/{index}
Delete a HTTP check
deleteHTTPCheckBackend 5 params → 202204404default
GET
/services/haproxy/configuration/backends/{parent_name}/http_checks/{index}
Return one HTTP check
getHTTPCheckBackend 3 params → 200404default
POST
/services/haproxy/configuration/backends/{parent_name}/http_checks/{index}
Add a new HTTP check
createHTTPCheckBackend 5 params body → 201202400409default
PUT
/services/haproxy/configuration/backends/{parent_name}/http_checks/{index}
Replace a HTTP check
replaceHTTPCheckBackend 5 params body → 200202400404default
DELETE
/services/haproxy/configuration/defaults/{parent_name}/http_checks/{index}
Delete a HTTP check
deleteHTTPCheckDefaults 5 params → 202204404default
GET
/services/haproxy/configuration/defaults/{parent_name}/http_checks/{index}
Return one HTTP check
getHTTPCheckDefaults 3 params → 200404default
POST
/services/haproxy/configuration/defaults/{parent_name}/http_checks/{index}
Add a new HTTP check
createHTTPCheckDefaults 5 params body → 201202400409default
PUT
/services/haproxy/configuration/defaults/{parent_name}/http_checks/{index}
Replace a HTTP check
replaceHTTPCheckDefaults 5 params body → 200202400404default
DELETE
/services/haproxy/configuration/healthchecks/{parent_name}/http_checks/{index}
Delete a HTTP check
deleteHTTPCheckHealthcheck 5 params → 202204404default
GET
/services/haproxy/configuration/healthchecks/{parent_name}/http_checks/{index}
Return one HTTP check
getHTTPCheckHealthcheck 3 params → 200404default
POST
/services/haproxy/configuration/healthchecks/{parent_name}/http_checks/{index}
Add a new HTTP check
createHTTPCheckHealthcheck 5 params body → 201202400409default
PUT
/services/haproxy/configuration/healthchecks/{parent_name}/http_checks/{index}
Replace a HTTP check
replaceHTTPCheckHealthcheck 5 params body → 200202400404default

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are http_check (35 properties), error (2 properties), return_header (2 properties). Each schema is shown below with its type and property counts.

return_header
object
2 properties 2 required
http_check
object
35 properties 1 required
http_checks
array
error
object
API Error
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

haproxy-httpcheck-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 HTTP 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.