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 Backend API

Managing backend configurations (advanced mode)

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Backend. 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 60 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 60 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 Backend 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.

Backend 5

Managing backend configurations (advanced mode)

GET
/services/haproxy/configuration/backends
Return an array of backends
getBackends 2 params → 200default
POST
/services/haproxy/configuration/backends
Add a backend
createBackend 4 params body → 201202400409default
DELETE
/services/haproxy/configuration/backends/{name}
Delete a backend
deleteBackend 4 params → 202204404default
GET
/services/haproxy/configuration/backends/{name}
Return a backend
getBackend 3 params → 200404default
PUT
/services/haproxy/configuration/backends/{name}
Replace a backend
replaceBackend 5 params body → 200202400404default

Schemas 60

The contract defines 60 schemas that model the data the API accepts and returns. The most detailed are server_params (111 properties), backend_base (90 properties), http_request_rule (74 properties), http_response_rule (60 properties). Each schema is shown below with its type and property counts.

stats_auth
object
2 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)
server_switching_rules
array
HAProxy backend server switching rules array (corresponds to use-server directives)
compression
object
10 properties
hash_type
object
3 properties
server_template
Set a template to initialize servers with shared parameters.
acls
array
HAProxy ACL lines array (corresponds to acl directives)
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
balance
object
13 properties 1 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
httpchk_params
object
4 properties
http_request_rule
object
HAProxy HTTP request rule configuration (corresponds to http-request directives)
74 properties 1 required
forwardfor
object
4 properties 1 required
source
object
8 properties 1 required
log_target
object
Per-instance logging of events and traffic.
12 properties
pgsql_check_params
object
1 property
backend_base
object
HAProxy backend configuration
90 properties 1 required
stats_http_request
object
4 properties 1 required
email_alert
object
Send emails for important log messages.
6 properties 3 required
tcp_response_rules
array
HAProxy TCP response rules array (corresponds to tcp-response directive)
log_targets
array
HAProxy log target array (corresponds to log directives)
server_switching_rule
object
HAProxy server switching rule configuration (corresponds to use-server directive)
4 properties 1 required
errorfile
object
2 properties
http_checks
array
error
object
API Error
2 properties 2 required
server_params
object
111 properties
return_header
object
2 properties 2 required
use_small_buffers
object
Enables support for small buffers for the given categories.
4 properties 1 required
http_request_rules
array
HAProxy HTTP request rules array (corresponds to http-request directives)
filters
array
HAProxy filters array (corresponds to filter directive)
redispatch
object
2 properties 1 required
mysql_check_params
object
2 properties
errorfiles
object
3 properties
server
HAProxy backend server configuration
tcp_response_rule
object
HAProxy TCP Response Rule configuration (corresponds to tcp-response)
27 properties 1 required
errorloc
object
3 properties 2 required
persist_rule
object
2 properties 1 required
http_check
object
35 properties 1 required
cookie
object
13 properties 1 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
default_server
stick_rule
object
Define a pattern used to create an entry in a stickiness table or matching condition or associate a user to a server.
6 properties 2 required
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)
tcp_checks
array
smtpchk_params
object
2 properties
stick_rules
array
HAProxy backend stick rules array (corresponds to stick store-request, stick match, stick on, stick store-response)
http_response_rules
array
HAProxy HTTP response rules array (corresponds to http-response directives)
backends
array
HAProxy backends array
backend
object
Backend with all its children resources
stats_options
object
17 properties
filter_sequences
array
HAProxy filter sequences array (corresponds to filter-sequence directive)
originalto
object
3 properties 1 required
filter
object
HAProxy filters
20 properties 1 required
tcp_check
object
32 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

haproxy-backend-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 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
HAProxy Crt Store API
AE Profile APIs.io
#Backend
← Back to H APIs
API Details
ID
haproxy:haproxy-backend-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-backend-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/haproxy-backend-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 Backend 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.