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

Managing backend server configurations (advanced mode)

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Servers. 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 20 operations across 8 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 3.4.

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

20 operations 8 paths 7 schemas 4 DELETE8 GET4 POST4 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 Server API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basic_auth). By default, every request must be authenticated.

Paths & Operations 20

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

Server 20

Managing backend server configurations (advanced mode)

GET
/services/haproxy/configuration/backends/{parent_name}/servers
Return an array of servers
getAllServerBackend 2 params → 200default
POST
/services/haproxy/configuration/backends/{parent_name}/servers
Add a new server
createServerBackend 4 params body → 201202400409default
GET
/services/haproxy/configuration/peers/{parent_name}/servers
Return an array of servers
getAllServerPeer 2 params → 200default
POST
/services/haproxy/configuration/peers/{parent_name}/servers
Add a new server
createServerPeer 4 params body → 201202400409default
GET
/services/haproxy/configuration/rings/{parent_name}/servers
Return an array of servers
getAllServerRing 2 params → 200default
POST
/services/haproxy/configuration/rings/{parent_name}/servers
Add a new server
createServerRing 4 params body → 201202400409default
DELETE
/services/haproxy/configuration/backends/{parent_name}/servers/{name}
Delete a server
deleteServerBackend 5 params → 202204404default
GET
/services/haproxy/configuration/backends/{parent_name}/servers/{name}
Return one server
getServerBackend 3 params → 200404default
PUT
/services/haproxy/configuration/backends/{parent_name}/servers/{name}
Replace a server
replaceServerBackend 5 params body → 200202400404default
DELETE
/services/haproxy/configuration/peers/{parent_name}/servers/{name}
Delete a server
deleteServerPeer 5 params → 202204404default
GET
/services/haproxy/configuration/peers/{parent_name}/servers/{name}
Return one server
getServerPeer 3 params → 200404default
PUT
/services/haproxy/configuration/peers/{parent_name}/servers/{name}
Replace a server
replaceServerPeer 5 params body → 200202400404default
DELETE
/services/haproxy/configuration/rings/{parent_name}/servers/{name}
Delete a server
deleteServerRing 5 params → 202204404default
GET
/services/haproxy/configuration/rings/{parent_name}/servers/{name}
Return one server
getServerRing 3 params → 200404default
PUT
/services/haproxy/configuration/rings/{parent_name}/servers/{name}
Replace a server
replaceServerRing 5 params body → 200202400404default
GET
/services/haproxy/runtime/backends/{parent_name}/servers
Return an array of runtime servers' settings
getAllRuntimeServer 1 param → 200default
POST
/services/haproxy/runtime/backends/{parent_name}/servers
Adds a new server to a backend
addRuntimeServer 1 param body → 201400404409default
DELETE
/services/haproxy/runtime/backends/{parent_name}/servers/{name}
Deletes a server from a backend
deleteRuntimeServer 2 params → 204400404default
GET
/services/haproxy/runtime/backends/{parent_name}/servers/{name}
Return one server runtime settings
getRuntimeServer 2 params → 200404default
PUT
/services/haproxy/runtime/backends/{parent_name}/servers/{name}
Replace server transient settings
replaceRuntimeServer 2 params body → 200400404default

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are server_params (111 properties), runtime_add_server (74 properties), runtime_server (26 properties), error (2 properties). Each schema is shown below with its type and property counts.

runtime_server
object
Runtime transient server properties
26 properties
server
HAProxy backend server configuration
runtime_servers
array
HAProxy runtime servers array
error
object
API Error
2 properties 2 required
runtime_add_server
object
Settable properties when adding a new server using HAProxy's runtime.
74 properties
servers
array
HAProxy backend servers array
server_params
object
111 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

haproxy-server-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
#Servers
← Back to H APIs
API Details
ID
haproxy:haproxy-server-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-server-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/haproxy-server-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 Server 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.