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 Response Rule API

The HTTPResponseRule API from HAProxy — 6 operation(s) for httpresponserule.

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

Tagged areas include HTTPResponseRule. 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 Response Rule 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.

HTTPResponseRule 18
GET
/services/haproxy/configuration/backends/{parent_name}/http_response_rules
Return an array of all HTTP Response Rules
getAllHTTPResponseRuleBackend 2 params → 200default
PUT
/services/haproxy/configuration/backends/{parent_name}/http_response_rules
Replace an HTTP Response Rule list
replaceAllHTTPResponseRuleBackend 4 params body → 200202400default
GET
/services/haproxy/configuration/frontends/{parent_name}/http_response_rules
Return an array of all HTTP Response Rules
getAllHTTPResponseRuleFrontend 2 params → 200default
PUT
/services/haproxy/configuration/frontends/{parent_name}/http_response_rules
Replace an HTTP Response Rule list
replaceAllHTTPResponseRuleFrontend 4 params body → 200202400default
GET
/services/haproxy/configuration/defaults/{parent_name}/http_response_rules
Return an array of all HTTP Response Rules
getAllHTTPResponseRuleDefaults 2 params → 200default
PUT
/services/haproxy/configuration/defaults/{parent_name}/http_response_rules
Replace an HTTP Response Rule list
replaceAllHTTPResponseRuleDefaults 4 params body → 200202400default
DELETE
/services/haproxy/configuration/backends/{parent_name}/http_response_rules/{index}
Delete a HTTP Response Rule
deleteHTTPResponseRuleBackend 5 params → 202204404default
GET
/services/haproxy/configuration/backends/{parent_name}/http_response_rules/{index}
Return one HTTP Response Rule
getHTTPResponseRuleBackend 3 params → 200404default
POST
/services/haproxy/configuration/backends/{parent_name}/http_response_rules/{index}
Add a new HTTP Response Rule
createHTTPResponseRuleBackend 5 params body → 201202400409default
PUT
/services/haproxy/configuration/backends/{parent_name}/http_response_rules/{index}
Replace a HTTP Response Rule
replaceHTTPResponseRuleBackend 5 params body → 200202400404default
DELETE
/services/haproxy/configuration/frontends/{parent_name}/http_response_rules/{index}
Delete a HTTP Response Rule
deleteHTTPResponseRuleFrontend 5 params → 202204404default
GET
/services/haproxy/configuration/frontends/{parent_name}/http_response_rules/{index}
Return one HTTP Response Rule
getHTTPResponseRuleFrontend 3 params → 200404default
POST
/services/haproxy/configuration/frontends/{parent_name}/http_response_rules/{index}
Add a new HTTP Response Rule
createHTTPResponseRuleFrontend 5 params body → 201202400409default
PUT
/services/haproxy/configuration/frontends/{parent_name}/http_response_rules/{index}
Replace a HTTP Response Rule
replaceHTTPResponseRuleFrontend 5 params body → 200202400404default
DELETE
/services/haproxy/configuration/defaults/{parent_name}/http_response_rules/{index}
Delete a HTTP Response Rule
deleteHTTPResponseRuleDefaults 5 params → 202204404default
GET
/services/haproxy/configuration/defaults/{parent_name}/http_response_rules/{index}
Return one HTTP Response Rule
getHTTPResponseRuleDefaults 3 params → 200404default
POST
/services/haproxy/configuration/defaults/{parent_name}/http_response_rules/{index}
Add a new HTTP Response Rule
createHTTPResponseRuleDefaults 5 params body → 201202400409default
PUT
/services/haproxy/configuration/defaults/{parent_name}/http_response_rules/{index}
Replace a HTTP Response Rule
replaceHTTPResponseRuleDefaults 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_response_rule (60 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_response_rules
array
HAProxy HTTP response rules array (corresponds to http-response directives)
http_response_rule
object
HAProxy HTTP response rule configuration (corresponds to http-response directives)
60 properties 1 required
error
object
API Error
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

haproxy-httpresponserule-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 Response Rule 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.