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 TCP Request Rule API

The TCPRequestRule API from HAProxy — 6 operation(s) for tcprequestrule.

HAProxy TCP Request 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 TCPRequestRule. 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 3 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 3 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 TCP Request 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.

TCPRequestRule 18
GET
/services/haproxy/configuration/backends/{parent_name}/tcp_request_rules
Return an array of all TCP Request Rules
getAllTCPRequestRuleBackend 2 params → 200default
PUT
/services/haproxy/configuration/backends/{parent_name}/tcp_request_rules
Replace an TCP Request Rule list
replaceAllTCPRequestRuleBackend 4 params body → 200202400default
GET
/services/haproxy/configuration/frontends/{parent_name}/tcp_request_rules
Return an array of all TCP Request Rules
getAllTCPRequestRuleFrontend 2 params → 200default
PUT
/services/haproxy/configuration/frontends/{parent_name}/tcp_request_rules
Replace an TCP Request Rule list
replaceAllTCPRequestRuleFrontend 4 params body → 200202400default
GET
/services/haproxy/configuration/defaults/{parent_name}/tcp_request_rules
Return an array of all TCP Request Rules
getAllTCPRequestRuleDefaults 2 params → 200default
PUT
/services/haproxy/configuration/defaults/{parent_name}/tcp_request_rules
Replace an TCP Request Rule list
replaceAllTCPRequestRuleDefaults 4 params body → 200202400default
DELETE
/services/haproxy/configuration/backends/{parent_name}/tcp_request_rules/{index}
Delete a TCP Request Rule
deleteTCPRequestRuleBackend 5 params → 202204404default
GET
/services/haproxy/configuration/backends/{parent_name}/tcp_request_rules/{index}
Return one TCP Request Rule
getTCPRequestRuleBackend 3 params → 200404default
POST
/services/haproxy/configuration/backends/{parent_name}/tcp_request_rules/{index}
Add a new TCP Request Rule
createTCPRequestRuleBackend 5 params body → 201202400409default
PUT
/services/haproxy/configuration/backends/{parent_name}/tcp_request_rules/{index}
Replace a TCP Request Rule
replaceTCPRequestRuleBackend 5 params body → 200202400404default
DELETE
/services/haproxy/configuration/frontends/{parent_name}/tcp_request_rules/{index}
Delete a TCP Request Rule
deleteTCPRequestRuleFrontend 5 params → 202204404default
GET
/services/haproxy/configuration/frontends/{parent_name}/tcp_request_rules/{index}
Return one TCP Request Rule
getTCPRequestRuleFrontend 3 params → 200404default
POST
/services/haproxy/configuration/frontends/{parent_name}/tcp_request_rules/{index}
Add a new TCP Request Rule
createTCPRequestRuleFrontend 5 params body → 201202400409default
PUT
/services/haproxy/configuration/frontends/{parent_name}/tcp_request_rules/{index}
Replace a TCP Request Rule
replaceTCPRequestRuleFrontend 5 params body → 200202400404default
DELETE
/services/haproxy/configuration/defaults/{parent_name}/tcp_request_rules/{index}
Delete a TCP Request Rule
deleteTCPRequestRuleDefaults 5 params → 202204404default
GET
/services/haproxy/configuration/defaults/{parent_name}/tcp_request_rules/{index}
Return one TCP Request Rule
getTCPRequestRuleDefaults 3 params → 200404default
POST
/services/haproxy/configuration/defaults/{parent_name}/tcp_request_rules/{index}
Add a new TCP Request Rule
createTCPRequestRuleDefaults 5 params body → 201202400409default
PUT
/services/haproxy/configuration/defaults/{parent_name}/tcp_request_rules/{index}
Replace a TCP Request Rule
replaceTCPRequestRuleDefaults 5 params body → 200202400404default

Schemas 3

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

tcp_request_rules
array
HAProxy TCP request rules array (corresponds to tcp-request directive)
tcp_request_rule
object
HAProxy TCP Request Rule configuration (corresponds to tcp-request)
38 properties 1 required
error
object
API Error
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

haproxy-tcprequestrule-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 TCP Request 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.