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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
HAProxy

HAProxy Frontend API

Managing frontend configuration (advanced mode)

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Frontend. 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 49 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 49 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
Authentication
HTTP Basic
Contact
HAProxy Support
Resource Areas
1

Authentication & Security 1

HAProxy Frontend 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.

Frontend 5

Managing frontend configuration (advanced mode)

GET
/services/haproxy/configuration/frontends
Return an array of frontends
getFrontends 2 params → 200default
POST
/services/haproxy/configuration/frontends
Add a frontend
createFrontend 4 params body → 201202400409default
DELETE
/services/haproxy/configuration/frontends/{name}
Delete a frontend
deleteFrontend 4 params → 202204404default
GET
/services/haproxy/configuration/frontends/{name}
Return a frontend
getFrontend 3 params → 200404default
PUT
/services/haproxy/configuration/frontends/{name}
Replace a frontend
replaceFrontend 5 params body → 200202400404default

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are bind_params (87 properties), http_request_rule (74 properties), frontend_base (71 properties), http_response_rule (60 properties). Each schema is shown below with its type and property counts.

stats_auth
object
2 properties 2 required
force_be_switch
object
Allow content switching to select a backend instance even if it is disabled or unpublished. May appear multiple times on a frontend.
3 properties 2 required
forwarded
object
Controls insertion of the HTTP Forwarded header field.
12 properties 1 required
tcp_request_rules
array
HAProxy TCP request rules array (corresponds to tcp-request directive)
compression
object
10 properties
quic_initial_rules
array
ssl_front_uses
array
acls
array
HAProxy ACL lines array (corresponds to acl directives)
ssl_front_use
object
Assign a certificate to the current frontend
23 properties 1 required
acl
object
The use of Access Control Lists (ACL) provides a flexible solution to perform content switching and generally to take decisions based on content extracted from…
4 properties 2 required
filter_sequence
object
Specifies in which order filters declared on the proxy should be executed for the request or response path. Corresponds to the HAProxy filter-sequence directiv…
3 properties 2 required
bind_params
object
87 properties
http_request_rule
object
HAProxy HTTP request rule configuration (corresponds to http-request directives)
74 properties 1 required
monitor_uri
string
forwardfor
object
4 properties 1 required
quic_initial_rule
object
QUIC Initial configuration
4 properties 1 required
log_target
object
Per-instance logging of events and traffic.
12 properties
stats_http_request
object
4 properties 1 required
email_alert
object
Send emails for important log messages.
6 properties 3 required
log_targets
array
HAProxy log target array (corresponds to log directives)
errorfile
object
2 properties
backend_switching_rule
object
HAProxy backend switching rule configuration (corresponds to usebackend directive)
4 properties 1 required
error
object
API Error
2 properties 2 required
return_header
object
2 properties 2 required
backend_switching_rules
array
HAProxy backend switching rules array (corresponds to usebackend directives)
http_request_rules
array
HAProxy HTTP request rules array (corresponds to http-request directives)
bind
HAProxy frontend bind configuration
filters
array
HAProxy filters array (corresponds to filter directive)
errorfiles
object
3 properties
monitor_fail
object
2 properties 2 required
errorloc
object
3 properties 2 required
http_response_rule
object
HAProxy HTTP response rule configuration (corresponds to http-response directives)
60 properties 1 required
http_after_response_rule
object
HAProxy HTTP after response rule configuration (corresponds to http-after-response directives)
31 properties 1 required
http_error_rule
object
HAProxy HTTP error rule configuration (corresponds to http-error directives)
7 properties 2 required
tcp_request_rule
object
HAProxy TCP Request Rule configuration (corresponds to tcp-request)
38 properties 1 required
frontends
array
HAProxy frontends array
frontend
object
Frontend with all its children resources
config_stick_table
object
11 properties
http_after_response_rules
array
HAProxy HTTP after response rules array (corresponds to http-after-response directives)
http_error_rules
array
HAProxy HTTP error rules array (corresponds to http-error directives)
force_be_switches
array
capture
object
3 properties 2 required
http_response_rules
array
HAProxy HTTP response rules array (corresponds to http-response directives)
stats_options
object
17 properties
captures
array
filter_sequences
array
HAProxy filter sequences array (corresponds to filter-sequence directive)
frontend_base
object
HAProxy frontend configuration
71 properties 1 required
originalto
object
3 properties 1 required
filter
object
HAProxy filters
20 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

haproxy-frontend-api-openapi.yml Raw ↑

Other APIs HAProxy publishes across the network.

HAProxy Runtime API
AE Profile APIs.io
HAProxy Kubernetes Ingress Controller
AE Profile APIs.io
HAProxy ACL API
AE Profile APIs.io
HAProxy ACL Runtime API
AE Profile APIs.io
HAProxy Acme API
AE Profile APIs.io
HAProxy Acme Runtime API
AE Profile APIs.io
HAProxy Backend API
AE Profile APIs.io
HAProxy Backend Switching Rule API
AE Profile APIs.io
HAProxy Bind API
AE Profile APIs.io
HAProxy Cache API
AE Profile APIs.io
HAProxy Configuration API
AE Profile APIs.io
HAProxy Crt Load API
AE Profile APIs.io
#Frontend
← Back to H APIs
API Details
ID
haproxy:haproxy-frontend-api
Base URL
http://{haproxy-host}:5555/v3
Docs
https://www.haproxy.com/documentation/dataplaneapi/latest/
Provider
HAProxy
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=haproxy-frontend-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/haproxy-frontend-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of HAProxy Frontend 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.