HAProxy Data Plane API
The HAProxy Data Plane API is a REST API for managing HAProxy configuration dynamically. It allows runtime configuration of frontends, backends, servers, ACLs, and other HAProxy objects without requiring configuration file changes or restarts.
HAProxy Data Plane API is one of 3 APIs that HAProxy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Configuration, Load Balancing, and REST API. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, an API reference, a getting-started guide, a GitHub repository, and a changelog.
This API exposes 557 operations across 223 paths, organized into 66 resource areas, and defines 232 schemas. It is described by OpenAPI 2.0, at version 3.4.
Requests are made against the base URL http://{haproxy-host}:5555/v3.
557 operations
223 paths
232 schemas
99 DELETE221 GET101 POST136 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
HAProxy Data Plane API declares
1 security scheme
for authenticating requests.
It defines a basic scheme (basic_auth).
By default, every request must be authenticated.
Paths & Operations 557
Across 223 paths, the API surfaces 557 operations — 99 DELETE, 221 GET, 101 POST, 136 PUT. They span 66 resource areas, including Discovery, Specification, SpecificationOpenapiv3, Information, Health, ServiceDiscovery, Sites, Stats, and 58 more. Each is listed below with its method, path, parameters, and response codes.
Discovery 8
API autodiscover endpoints
GET
/
Return list of root endpoints
GET
/services
Return list of service endpoints
GET
/services/haproxy
Return list of HAProxy related endpoints
GET
/services/haproxy/stats
Return list of HAProxy stats endpoints
GET
/services/haproxy/configuration
Return list of HAProxy advanced configuration endpoints
GET
/services/haproxy/runtime
Return list of HAProxy advanced runtime endpoints
GET
/services/haproxy/storage
Return list of HAProxy storage endpoints
GET
/services/haproxy/spoe
Return list of HAProxy SPOE endpoints
Specification 1
GET
/specification
Data Plane API Specification
SpecificationOpenapiv3 1
GET
/specification_openapiv3
Data Plane API v3 Specification
Information 2
GET
/info
Return API, hardware and OS information
GET
/services/haproxy/runtime/info
Return HAProxy process information
Health 1
GET
/health
Return managed services health
ServiceDiscovery 10
GET
/service_discovery/aws
Return an array of all configured AWS regions
POST
/service_discovery/aws
Add a new AWS region
DELETE
/service_discovery/aws/{id}
Delete an AWS region
GET
/service_discovery/aws/{id}
Return an AWS region
PUT
/service_discovery/aws/{id}
Replace an AWS region
GET
/service_discovery/consul
Return an array of all configured Consul servers
POST
/service_discovery/consul
Add a new Consul server
DELETE
/service_discovery/consul/{id}
Delete a Consul server
GET
/service_discovery/consul/{id}
Return one Consul server
PUT
/service_discovery/consul/{id}
Replace a Consul server
Sites 5
Managing sites (simple configuration mode). Sites are considered as one frontend with multiple backends connected to it via defaultbackend or use-backend directives.
GET
/services/haproxy/sites
Return an array of sites
POST
/services/haproxy/sites
Add a site
DELETE
/services/haproxy/sites/{name}
Delete a site
GET
/services/haproxy/sites/{name}
Return a site
PUT
/services/haproxy/sites/{name}
Replace a site
Stats 1
Stats container
GET
/services/haproxy/stats/native
Gets stats
Transactions 5
Managing transactions. Configuration changes can be grouped in the transaction. You start the transaction with trasactions POST, and call the configuration changes you need with p…
GET
/services/haproxy/transactions
Return list of HAProxy configuration transactions.
POST
/services/haproxy/transactions
Start a new transaction
DELETE
/services/haproxy/transactions/{id}
Delete a transaction
GET
/services/haproxy/transactions/{id}
Return one HAProxy configuration transactions
PUT
/services/haproxy/transactions/{id}
Commit transaction
SpoeTransactions 5
GET
/services/haproxy/spoe/spoe_files/{parent_name}/transactions
Return list of SPOE configuration transactions.
POST
/services/haproxy/spoe/spoe_files/{parent_name}/transactions
Start a new transaction
DELETE
/services/haproxy/spoe/spoe_files/{parent_name}/transactions/{id}
Delete a transaction
GET
/services/haproxy/spoe/spoe_files/{parent_name}/transactions/{id}
Return one SPOE configuration transactions
PUT
/services/haproxy/spoe/spoe_files/{parent_name}/transactions/{id}
Commit transaction
Reloads 2
Checking reload success. To avoid constant reloading we reload in intervals that are configurable when with reload-delay option. When a change to configuration is made and forcere…
GET
/services/haproxy/reloads
Return list of HAProxy Reloads.
GET
/services/haproxy/reloads/{id}
Return one HAProxy reload status
Global 2
Managing global configuration (advanced mode)
GET
/services/haproxy/configuration/global
Return a global part of configuration
PUT
/services/haproxy/configuration/global
Replace global
Defaults 6
Managing defaults configuration (advanced mode)
GET
/services/haproxy/configuration/defaults
Return an array of defaults
POST
/services/haproxy/configuration/defaults
Add a defaults section
PUT
/services/haproxy/configuration/defaultsdeprecated
Add a defaults section
DELETE
/services/haproxy/configuration/defaults/{name}
Delete a defaults section
GET
/services/haproxy/configuration/defaults/{name}
Return a defaults section
PUT
/services/haproxy/configuration/defaults/{name}
Replace a defatults section
Frontend 5
Managing frontend configuration (advanced mode)
GET
/services/haproxy/configuration/frontends
Return an array of frontends
POST
/services/haproxy/configuration/frontends
Add a frontend
DELETE
/services/haproxy/configuration/frontends/{name}
Delete a frontend
GET
/services/haproxy/configuration/frontends/{name}
Return a frontend
PUT
/services/haproxy/configuration/frontends/{name}
Replace a frontend
Userlist 4
GET
/services/haproxy/configuration/userlists
Return an array of userlists
POST
/services/haproxy/configuration/userlists
Add a new userlist
DELETE
/services/haproxy/configuration/userlists/{name}
Delete a userlist
GET
/services/haproxy/configuration/userlists/{name}
Return one userlist
User 5
GET
/services/haproxy/configuration/users
Return an array of userlist users
POST
/services/haproxy/configuration/users
Add a new userlist user
DELETE
/services/haproxy/configuration/users/{username}
Delete a user
GET
/services/haproxy/configuration/users/{username}
Return one userlist user
PUT
/services/haproxy/configuration/users/{username}
Replace a user
Group 5
GET
/services/haproxy/configuration/groups
Return an array of userlist groups
POST
/services/haproxy/configuration/groups
Add a new userlist group
DELETE
/services/haproxy/configuration/groups/{name}
Delete a group
GET
/services/haproxy/configuration/groups/{name}
Return one userlist group
PUT
/services/haproxy/configuration/groups/{name}
Replace a group
Mailers 5
GET
/services/haproxy/configuration/mailers_sectiondeprecated
Return an array of mailers sections
POST
/services/haproxy/configuration/mailers_sectiondeprecated
Add a new Mailers section
DELETE
/services/haproxy/configuration/mailers_section/{name}deprecated
Delete a Mailers section
GET
/services/haproxy/configuration/mailers_section/{name}deprecated
Return a Mailers section
PUT
/services/haproxy/configuration/mailers_section/{name}deprecated
Modify a Mailers section
MailerEntry 5
GET
/services/haproxy/configuration/mailer_entriesdeprecated
Return an array of mailerentries
POST
/services/haproxy/configuration/mailer_entriesdeprecated
Add a new mailerentry
DELETE
/services/haproxy/configuration/mailer_entries/{name}deprecated
Delete a mailerentry
GET
/services/haproxy/configuration/mailer_entries/{name}deprecated
Return one mailerentry
PUT
/services/haproxy/configuration/mailer_entries/{name}deprecated
Replace a mailerentry
Peer 4
GET
/services/haproxy/configuration/peer_section
Return an array of peersection
POST
/services/haproxy/configuration/peer_section
Add a peer
DELETE
/services/haproxy/configuration/peer_section/{name}
Delete a peer
GET
/services/haproxy/configuration/peer_section/{name}
Return a peer
PeerEntry 5
GET
/services/haproxy/configuration/peer_entries
Return an array of peerentries
POST
/services/haproxy/configuration/peer_entries
Add a new peerentry
DELETE
/services/haproxy/configuration/peer_entries/{name}
Delete a peerentry
GET
/services/haproxy/configuration/peer_entries/{name}
Return one peerentry
PUT
/services/haproxy/configuration/peer_entries/{name}
Replace a peerentry
HTTPErrors 5
GET
/services/haproxy/configuration/http_errors_sections
Return an array of http-error sections
POST
/services/haproxy/configuration/http_errors_sections
Add a new http-error section
DELETE
/services/haproxy/configuration/http_errors_sections/{name}
Delete a http-error section
GET
/services/haproxy/configuration/http_errors_sections/{name}
Return a http-error section
PUT
/services/haproxy/configuration/http_errors_sections/{name}
Replace a http-error section
FCGIApp 5
GET
/services/haproxy/configuration/fcgi_apps
Return an array of FCGI apps
POST
/services/haproxy/configuration/fcgi_apps
Add an FCGI app
DELETE
/services/haproxy/configuration/fcgi_apps/{name}
Delete an FCGI app
GET
/services/haproxy/configuration/fcgi_apps/{name}
Return a FCGI app
PUT
/services/haproxy/configuration/fcgi_apps/{name}
Replace a FCGI app
Backend 5
Managing backend configurations (advanced mode)
GET
/services/haproxy/configuration/backends
Return an array of backends
POST
/services/haproxy/configuration/backends
Add a backend
DELETE
/services/haproxy/configuration/backends/{name}
Delete a backend
GET
/services/haproxy/configuration/backends/{name}
Return a backend
PUT
/services/haproxy/configuration/backends/{name}
Replace a backend
Server 20
Managing backend server configurations (advanced mode)
GET
/services/haproxy/configuration/backends/{parent_name}/servers
Return an array of servers
POST
/services/haproxy/configuration/backends/{parent_name}/servers
Add a new server
GET
/services/haproxy/configuration/peers/{parent_name}/servers
Return an array of servers
POST
/services/haproxy/configuration/peers/{parent_name}/servers
Add a new server
GET
/services/haproxy/configuration/rings/{parent_name}/servers
Return an array of servers
POST
/services/haproxy/configuration/rings/{parent_name}/servers
Add a new server
DELETE
/services/haproxy/configuration/backends/{parent_name}/servers/{name}
Delete a server
GET
/services/haproxy/configuration/backends/{parent_name}/servers/{name}
Return one server
PUT
/services/haproxy/configuration/backends/{parent_name}/servers/{name}
Replace a server
DELETE
/services/haproxy/configuration/peers/{parent_name}/servers/{name}
Delete a server
GET
/services/haproxy/configuration/peers/{parent_name}/servers/{name}
Return one server
PUT
/services/haproxy/configuration/peers/{parent_name}/servers/{name}
Replace a server
DELETE
/services/haproxy/configuration/rings/{parent_name}/servers/{name}
Delete a server
GET
/services/haproxy/configuration/rings/{parent_name}/servers/{name}
Return one server
PUT
/services/haproxy/configuration/rings/{parent_name}/servers/{name}
Replace a server
GET
/services/haproxy/runtime/backends/{parent_name}/servers
Return an array of runtime servers' settings
POST
/services/haproxy/runtime/backends/{parent_name}/servers
Adds a new server to a backend
DELETE
/services/haproxy/runtime/backends/{parent_name}/servers/{name}
Deletes a server from a backend
GET
/services/haproxy/runtime/backends/{parent_name}/servers/{name}
Return one server runtime settings
PUT
/services/haproxy/runtime/backends/{parent_name}/servers/{name}
Replace server transient settings
Ring 5
GET
/services/haproxy/configuration/rings
Return an array of rings
POST
/services/haproxy/configuration/rings
Add a ring
DELETE
/services/haproxy/configuration/rings/{name}
Delete a ring
GET
/services/haproxy/configuration/rings/{name}
Return a ring
PUT
/services/haproxy/configuration/rings/{name}
Replace a ring
Bind 15
Managing frontend bind configurations (advanced mode)
GET
/services/haproxy/configuration/frontends/{parent_name}/binds
Return an array of binds
POST
/services/haproxy/configuration/frontends/{parent_name}/binds
Add a new bind
GET
/services/haproxy/configuration/log_forwards/{parent_name}/binds
Return an array of binds
POST
/services/haproxy/configuration/log_forwards/{parent_name}/binds
Add a new bind
GET
/services/haproxy/configuration/peers/{parent_name}/binds
Return an array of binds
POST
/services/haproxy/configuration/peers/{parent_name}/binds
Add a new bind
DELETE
/services/haproxy/configuration/frontends/{parent_name}/binds/{name}
Delete a bind
GET
/services/haproxy/configuration/frontends/{parent_name}/binds/{name}
Return one bind
PUT
/services/haproxy/configuration/frontends/{parent_name}/binds/{name}
Replace a bind
DELETE
/services/haproxy/configuration/log_forwards/{parent_name}/binds/{name}
Delete a bind
GET
/services/haproxy/configuration/log_forwards/{parent_name}/binds/{name}
Return one bind
PUT
/services/haproxy/configuration/log_forwards/{parent_name}/binds/{name}
Replace a bind
DELETE
/services/haproxy/configuration/peers/{parent_name}/binds/{name}
Delete a bind
GET
/services/haproxy/configuration/peers/{parent_name}/binds/{name}
Return one bind
PUT
/services/haproxy/configuration/peers/{parent_name}/binds/{name}
Replace a bind
DgramBind 5
GET
/services/haproxy/configuration/log_forwards/{parent_name}/dgram_binds
Return an array of dgram binds
POST
/services/haproxy/configuration/log_forwards/{parent_name}/dgram_binds
Add a new dgram bind
DELETE
/services/haproxy/configuration/log_forwards/{parent_name}/dgram_binds/{name}
Delete a dgram bind
GET
/services/haproxy/configuration/log_forwards/{parent_name}/dgram_binds/{name}
Return one dgram bind
PUT
/services/haproxy/configuration/log_forwards/{parent_name}/dgram_binds/{name}
Replace a dgram bind
LogForward 5
GET
/services/haproxy/configuration/log_forwards
Return an array of log forwards
POST
/services/haproxy/configuration/log_forwards
Add a log forward
DELETE
/services/haproxy/configuration/log_forwards/{name}
Delete a log forward
GET
/services/haproxy/configuration/log_forwards/{name}
Return a log forward
PUT
/services/haproxy/configuration/log_forwards/{name}
Replace a log forward
ServerTemplate 5
GET
/services/haproxy/configuration/backends/{parent_name}/server_templates
Return an array of server templates
POST
/services/haproxy/configuration/backends/{parent_name}/server_templates
Add a new server template
DELETE
/services/haproxy/configuration/backends/{parent_name}/server_templates/{prefix}
Delete a server template
GET
/services/haproxy/configuration/backends/{parent_name}/server_templates/{prefix}
Return one server template
PUT
/services/haproxy/configuration/backends/{parent_name}/server_templates/{prefix}
Replace a server template
HTTPCheck 18
GET
/services/haproxy/configuration/backends/{parent_name}/http_checks
Return an array of HTTP checks
PUT
/services/haproxy/configuration/backends/{parent_name}/http_checks
Replace an HTTP checks list
GET
/services/haproxy/configuration/defaults/{parent_name}/http_checks
Return an array of HTTP checks
PUT
/services/haproxy/configuration/defaults/{parent_name}/http_checks
Replace an HTTP checks list
GET
/services/haproxy/configuration/healthchecks/{parent_name}/http_checks
Return an array of HTTP checks
PUT
/services/haproxy/configuration/healthchecks/{parent_name}/http_checks
Replace an HTTP checks list
DELETE
/services/haproxy/configuration/backends/{parent_name}/http_checks/{index}
Delete a HTTP check
GET
/services/haproxy/configuration/backends/{parent_name}/http_checks/{index}
Return one HTTP check
POST
/services/haproxy/configuration/backends/{parent_name}/http_checks/{index}
Add a new HTTP check
PUT
/services/haproxy/configuration/backends/{parent_name}/http_checks/{index}
Replace a HTTP check
DELETE
/services/haproxy/configuration/defaults/{parent_name}/http_checks/{index}
Delete a HTTP check
GET
/services/haproxy/configuration/defaults/{parent_name}/http_checks/{index}
Return one HTTP check
POST
/services/haproxy/configuration/defaults/{parent_name}/http_checks/{index}
Add a new HTTP check
PUT
/services/haproxy/configuration/defaults/{parent_name}/http_checks/{index}
Replace a HTTP check
DELETE
/services/haproxy/configuration/healthchecks/{parent_name}/http_checks/{index}
Delete a HTTP check
GET
/services/haproxy/configuration/healthchecks/{parent_name}/http_checks/{index}
Return one HTTP check
POST
/services/haproxy/configuration/healthchecks/{parent_name}/http_checks/{index}
Add a new HTTP check
PUT
/services/haproxy/configuration/healthchecks/{parent_name}/http_checks/{index}
Replace a HTTP check
HTTPRequestRule 18
GET
/services/haproxy/configuration/backends/{parent_name}/http_request_rules
Return an array of all HTTP Request Rules
PUT
/services/haproxy/configuration/backends/{parent_name}/http_request_rules
Replace an HTTP Request Rule list
GET
/services/haproxy/configuration/frontends/{parent_name}/http_request_rules
Return an array of all HTTP Request Rules
PUT
/services/haproxy/configuration/frontends/{parent_name}/http_request_rules
Replace an HTTP Request Rule list
GET
/services/haproxy/configuration/defaults/{parent_name}/http_request_rules
Return an array of all HTTP Request Rules
PUT
/services/haproxy/configuration/defaults/{parent_name}/http_request_rules
Replace an HTTP Request Rule list
DELETE
/services/haproxy/configuration/backends/{parent_name}/http_request_rules/{index}
Delete a HTTP Request Rule
GET
/services/haproxy/configuration/backends/{parent_name}/http_request_rules/{index}
Return one HTTP Request Rule
POST
/services/haproxy/configuration/backends/{parent_name}/http_request_rules/{index}
Add a new HTTP Request Rule
PUT
/services/haproxy/configuration/backends/{parent_name}/http_request_rules/{index}
Replace a HTTP Request Rule
DELETE
/services/haproxy/configuration/frontends/{parent_name}/http_request_rules/{index}
Delete a HTTP Request Rule
GET
/services/haproxy/configuration/frontends/{parent_name}/http_request_rules/{index}
Return one HTTP Request Rule
POST
/services/haproxy/configuration/frontends/{parent_name}/http_request_rules/{index}
Add a new HTTP Request Rule
PUT
/services/haproxy/configuration/frontends/{parent_name}/http_request_rules/{index}
Replace a HTTP Request Rule
DELETE
/services/haproxy/configuration/defaults/{parent_name}/http_request_rules/{index}
Delete a HTTP Request Rule
GET
/services/haproxy/configuration/defaults/{parent_name}/http_request_rules/{index}
Return one HTTP Request Rule
POST
/services/haproxy/configuration/defaults/{parent_name}/http_request_rules/{index}
Add a new HTTP Request Rule
PUT
/services/haproxy/configuration/defaults/{parent_name}/http_request_rules/{index}
Replace a HTTP Request Rule
HTTPResponseRule 18
GET
/services/haproxy/configuration/backends/{parent_name}/http_response_rules
Return an array of all HTTP Response Rules
PUT
/services/haproxy/configuration/backends/{parent_name}/http_response_rules
Replace an HTTP Response Rule list
GET
/services/haproxy/configuration/frontends/{parent_name}/http_response_rules
Return an array of all HTTP Response Rules
PUT
/services/haproxy/configuration/frontends/{parent_name}/http_response_rules
Replace an HTTP Response Rule list
GET
/services/haproxy/configuration/defaults/{parent_name}/http_response_rules
Return an array of all HTTP Response Rules
PUT
/services/haproxy/configuration/defaults/{parent_name}/http_response_rules
Replace an HTTP Response Rule list
DELETE
/services/haproxy/configuration/backends/{parent_name}/http_response_rules/{index}
Delete a HTTP Response Rule
GET
/services/haproxy/configuration/backends/{parent_name}/http_response_rules/{index}
Return one HTTP Response Rule
POST
/services/haproxy/configuration/backends/{parent_name}/http_response_rules/{index}
Add a new HTTP Response Rule
PUT
/services/haproxy/configuration/backends/{parent_name}/http_response_rules/{index}
Replace a HTTP Response Rule
DELETE
/services/haproxy/configuration/frontends/{parent_name}/http_response_rules/{index}
Delete a HTTP Response Rule
GET
/services/haproxy/configuration/frontends/{parent_name}/http_response_rules/{index}
Return one HTTP Response Rule
POST
/services/haproxy/configuration/frontends/{parent_name}/http_response_rules/{index}
Add a new HTTP Response Rule
PUT
/services/haproxy/configuration/frontends/{parent_name}/http_response_rules/{index}
Replace a HTTP Response Rule
DELETE
/services/haproxy/configuration/defaults/{parent_name}/http_response_rules/{index}
Delete a HTTP Response Rule
GET
/services/haproxy/configuration/defaults/{parent_name}/http_response_rules/{index}
Return one HTTP Response Rule
POST
/services/haproxy/configuration/defaults/{parent_name}/http_response_rules/{index}
Add a new HTTP Response Rule
PUT
/services/haproxy/configuration/defaults/{parent_name}/http_response_rules/{index}
Replace a HTTP Response Rule
HTTPAfterResponseRule 18
GET
/services/haproxy/configuration/backends/{parent_name}/http_after_response_rules
Return an array of all HTTP After Response Rules
PUT
/services/haproxy/configuration/backends/{parent_name}/http_after_response_rules
Replace an HTTP After Response Rules list
GET
/services/haproxy/configuration/frontends/{parent_name}/http_after_response_rules
Return an array of all HTTP After Response Rules
PUT
/services/haproxy/configuration/frontends/{parent_name}/http_after_response_rules
Replace an HTTP After Response Rules list
GET
/services/haproxy/configuration/defaults/{parent_name}/http_after_response_rules
Return an array of all HTTP After Response Rules
PUT
/services/haproxy/configuration/defaults/{parent_name}/http_after_response_rules
Replace an HTTP After Response Rules list
DELETE
/services/haproxy/configuration/backends/{parent_name}/http_after_response_rules/{index}
Delete a HTTP After Response Rule
GET
/services/haproxy/configuration/backends/{parent_name}/http_after_response_rules/{index}
Return one HTTP After Response Rule
POST
/services/haproxy/configuration/backends/{parent_name}/http_after_response_rules/{index}
Add a new HTTP After Response Rule
PUT
/services/haproxy/configuration/backends/{parent_name}/http_after_response_rules/{index}
Replace a HTTP After Response Rule
DELETE
/services/haproxy/configuration/frontends/{parent_name}/http_after_response_rules/{index}
Delete a HTTP After Response Rule
GET
/services/haproxy/configuration/frontends/{parent_name}/http_after_response_rules/{index}
Return one HTTP After Response Rule
POST
/services/haproxy/configuration/frontends/{parent_name}/http_after_response_rules/{index}
Add a new HTTP After Response Rule
PUT
/services/haproxy/configuration/frontends/{parent_name}/http_after_response_rules/{index}
Replace a HTTP After Response Rule
DELETE
/services/haproxy/configuration/defaults/{parent_name}/http_after_response_rules/{index}
Delete a HTTP After Response Rule
GET
/services/haproxy/configuration/defaults/{parent_name}/http_after_response_rules/{index}
Return one HTTP After Response Rule
POST
/services/haproxy/configuration/defaults/{parent_name}/http_after_response_rules/{index}
Add a new HTTP After Response Rule
PUT
/services/haproxy/configuration/defaults/{parent_name}/http_after_response_rules/{index}
Replace a HTTP After Response Rule
HTTPErrorRule 18
GET
/services/haproxy/configuration/backends/{parent_name}/http_error_rules
Return an array of all HTTP Error Rules
PUT
/services/haproxy/configuration/backends/{parent_name}/http_error_rules
Replace an HTTP Error Rules list
GET
/services/haproxy/configuration/frontends/{parent_name}/http_error_rules
Return an array of all HTTP Error Rules
PUT
/services/haproxy/configuration/frontends/{parent_name}/http_error_rules
Replace an HTTP Error Rules list
GET
/services/haproxy/configuration/defaults/{parent_name}/http_error_rules
Return an array of all HTTP Error Rules
PUT
/services/haproxy/configuration/defaults/{parent_name}/http_error_rules
Replace an HTTP Error Rules list
DELETE
/services/haproxy/configuration/backends/{parent_name}/http_error_rules/{index}
Delete a HTTP Error Rule
GET
/services/haproxy/configuration/backends/{parent_name}/http_error_rules/{index}
Return one HTTP Error Rule
POST
/services/haproxy/configuration/backends/{parent_name}/http_error_rules/{index}
Add a new HTTP Error Rule
PUT
/services/haproxy/configuration/backends/{parent_name}/http_error_rules/{index}
Replace a HTTP Error Rule
DELETE
/services/haproxy/configuration/frontends/{parent_name}/http_error_rules/{index}
Delete a HTTP Error Rule
GET
/services/haproxy/configuration/frontends/{parent_name}/http_error_rules/{index}
Return one HTTP Error Rule
POST
/services/haproxy/configuration/frontends/{parent_name}/http_error_rules/{index}
Add a new HTTP Error Rule
PUT
/services/haproxy/configuration/frontends/{parent_name}/http_error_rules/{index}
Replace a HTTP Error Rule
DELETE
/services/haproxy/configuration/defaults/{parent_name}/http_error_rules/{index}
Delete a HTTP Error Rule
GET
/services/haproxy/configuration/defaults/{parent_name}/http_error_rules/{index}
Return one HTTP Error Rule
POST
/services/haproxy/configuration/defaults/{parent_name}/http_error_rules/{index}
Add a new HTTP Error Rule
PUT
/services/haproxy/configuration/defaults/{parent_name}/http_error_rules/{index}
Replace a HTTP Error Rule
QUICInitialRule 12
GET
/services/haproxy/configuration/frontends/{parent_name}/quic_initial_rules
Return an array of all QUIC Initial rules
PUT
/services/haproxy/configuration/frontends/{parent_name}/quic_initial_rules
Replace an QUIC Initial rules list
GET
/services/haproxy/configuration/defaults/{parent_name}/quic_initial_rules
Return an array of all QUIC Initial rules
PUT
/services/haproxy/configuration/defaults/{parent_name}/quic_initial_rules
Replace an QUIC Initial rules list
DELETE
/services/haproxy/configuration/frontends/{parent_name}/quic_initial_rules/{index}
Delete a QUIC Initial Rule
GET
/services/haproxy/configuration/frontends/{parent_name}/quic_initial_rules/{index}
Return one QUIC Initial Rule
POST
/services/haproxy/configuration/frontends/{parent_name}/quic_initial_rules/{index}
Add a new QUIC Initial Rule
PUT
/services/haproxy/configuration/frontends/{parent_name}/quic_initial_rules/{index}
Replace a QUIC Initial Rule
DELETE
/services/haproxy/configuration/defaults/{parent_name}/quic_initial_rules/{index}
Delete a QUIC Initial Rule
GET
/services/haproxy/configuration/defaults/{parent_name}/quic_initial_rules/{index}
Return one QUIC Initial Rule
POST
/services/haproxy/configuration/defaults/{parent_name}/quic_initial_rules/{index}
Add a new QUIC Initial Rule
PUT
/services/haproxy/configuration/defaults/{parent_name}/quic_initial_rules/{index}
Replace a QUIC Initial Rule
Table 5
GET
/services/haproxy/configuration/peers/{parent_name}/tables
Return an array of tables
POST
/services/haproxy/configuration/peers/{parent_name}/tables
Add a new table
DELETE
/services/haproxy/configuration/peers/{parent_name}/tables/{name}
Delete a table
GET
/services/haproxy/configuration/peers/{parent_name}/tables/{name}
Return one table
PUT
/services/haproxy/configuration/peers/{parent_name}/tables/{name}
Replace a table
TCPCheck 18
GET
/services/haproxy/configuration/backends/{parent_name}/tcp_checks
Return an array of TCP checks
PUT
/services/haproxy/configuration/backends/{parent_name}/tcp_checks
Replace an TCP Check list
GET
/services/haproxy/configuration/defaults/{parent_name}/tcp_checks
Return an array of TCP checks
PUT
/services/haproxy/configuration/defaults/{parent_name}/tcp_checks
Replace an TCP Check list
GET
/services/haproxy/configuration/healthchecks/{parent_name}/tcp_checks
Return an array of TCP checks
PUT
/services/haproxy/configuration/healthchecks/{parent_name}/tcp_checks
Replace an TCP Check list
DELETE
/services/haproxy/configuration/backends/{parent_name}/tcp_checks/{index}
Delete a TCP check
GET
/services/haproxy/configuration/backends/{parent_name}/tcp_checks/{index}
Return one TCP check
POST
/services/haproxy/configuration/backends/{parent_name}/tcp_checks/{index}
Add a new TCP check
PUT
/services/haproxy/configuration/backends/{parent_name}/tcp_checks/{index}
Replace a TCP check
DELETE
/services/haproxy/configuration/defaults/{parent_name}/tcp_checks/{index}
Delete a TCP check
GET
/services/haproxy/configuration/defaults/{parent_name}/tcp_checks/{index}
Return one TCP check
POST
/services/haproxy/configuration/defaults/{parent_name}/tcp_checks/{index}
Add a new TCP check
PUT
/services/haproxy/configuration/defaults/{parent_name}/tcp_checks/{index}
Replace a TCP check
DELETE
/services/haproxy/configuration/healthchecks/{parent_name}/tcp_checks/{index}
Delete a TCP check
GET
/services/haproxy/configuration/healthchecks/{parent_name}/tcp_checks/{index}
Return one TCP check
POST
/services/haproxy/configuration/healthchecks/{parent_name}/tcp_checks/{index}
Add a new TCP check
PUT
/services/haproxy/configuration/healthchecks/{parent_name}/tcp_checks/{index}
Replace a TCP check
TCPRequestRule 18
GET
/services/haproxy/configuration/backends/{parent_name}/tcp_request_rules
Return an array of all TCP Request Rules
PUT
/services/haproxy/configuration/backends/{parent_name}/tcp_request_rules
Replace an TCP Request Rule list
GET
/services/haproxy/configuration/frontends/{parent_name}/tcp_request_rules
Return an array of all TCP Request Rules
PUT
/services/haproxy/configuration/frontends/{parent_name}/tcp_request_rules
Replace an TCP Request Rule list
GET
/services/haproxy/configuration/defaults/{parent_name}/tcp_request_rules
Return an array of all TCP Request Rules
PUT
/services/haproxy/configuration/defaults/{parent_name}/tcp_request_rules
Replace an TCP Request Rule list
DELETE
/services/haproxy/configuration/backends/{parent_name}/tcp_request_rules/{index}
Delete a TCP Request Rule
GET
/services/haproxy/configuration/backends/{parent_name}/tcp_request_rules/{index}
Return one TCP Request Rule
POST
/services/haproxy/configuration/backends/{parent_name}/tcp_request_rules/{index}
Add a new TCP Request Rule
PUT
/services/haproxy/configuration/backends/{parent_name}/tcp_request_rules/{index}
Replace a TCP Request Rule
DELETE
/services/haproxy/configuration/frontends/{parent_name}/tcp_request_rules/{index}
Delete a TCP Request Rule
GET
/services/haproxy/configuration/frontends/{parent_name}/tcp_request_rules/{index}
Return one TCP Request Rule
POST
/services/haproxy/configuration/frontends/{parent_name}/tcp_request_rules/{index}
Add a new TCP Request Rule
PUT
/services/haproxy/configuration/frontends/{parent_name}/tcp_request_rules/{index}
Replace a TCP Request Rule
DELETE
/services/haproxy/configuration/defaults/{parent_name}/tcp_request_rules/{index}
Delete a TCP Request Rule
GET
/services/haproxy/configuration/defaults/{parent_name}/tcp_request_rules/{index}
Return one TCP Request Rule
POST
/services/haproxy/configuration/defaults/{parent_name}/tcp_request_rules/{index}
Add a new TCP Request Rule
PUT
/services/haproxy/configuration/defaults/{parent_name}/tcp_request_rules/{index}
Replace a TCP Request Rule
TCPResponseRule 12
GET
/services/haproxy/configuration/backends/{parent_name}/tcp_response_rules
Return an array of all TCP Response Rules
PUT
/services/haproxy/configuration/backends/{parent_name}/tcp_response_rules
Replace a TCP Response Rule list
GET
/services/haproxy/configuration/defaults/{parent_name}/tcp_response_rules
Return an array of all TCP Response Rules
PUT
/services/haproxy/configuration/defaults/{parent_name}/tcp_response_rules
Replace a TCP Response Rule list
DELETE
/services/haproxy/configuration/backends/{parent_name}/tcp_response_rules/{index}
Delete a TCP Response Rule
GET
/services/haproxy/configuration/backends/{parent_name}/tcp_response_rules/{index}
Return one TCP Response Rule
POST
/services/haproxy/configuration/backends/{parent_name}/tcp_response_rules/{index}
Add a new TCP Response Rule
PUT
/services/haproxy/configuration/backends/{parent_name}/tcp_response_rules/{index}
Replace a TCP Response Rule
DELETE
/services/haproxy/configuration/defaults/{parent_name}/tcp_response_rules/{index}
Delete a TCP Response Rule
GET
/services/haproxy/configuration/defaults/{parent_name}/tcp_response_rules/{index}
Return one TCP Response Rule
POST
/services/haproxy/configuration/defaults/{parent_name}/tcp_response_rules/{index}
Add a new TCP Response Rule
PUT
/services/haproxy/configuration/defaults/{parent_name}/tcp_response_rules/{index}
Replace a TCP Response Rule
BackendSwitchingRule 6
GET
/services/haproxy/configuration/frontends/{parent_name}/backend_switching_rules
Return an array of all Backend Switching Rules
PUT
/services/haproxy/configuration/frontends/{parent_name}/backend_switching_rules
Replace an Backend Switching Rule list
DELETE
/services/haproxy/configuration/frontends/{parent_name}/backend_switching_rules/{index}
Delete a Backend Switching Rule
GET
/services/haproxy/configuration/frontends/{parent_name}/backend_switching_rules/{index}
Return one Backend Switching Rule
POST
/services/haproxy/configuration/frontends/{parent_name}/backend_switching_rules/{index}
Add a new Backend Switching Rule
PUT
/services/haproxy/configuration/frontends/{parent_name}/backend_switching_rules/{index}
Replace a Backend Switching Rule
ServerSwitchingRule 6
GET
/services/haproxy/configuration/backends/{parent_name}/server_switching_rules
Return an array of all Server Switching Rules
PUT
/services/haproxy/configuration/backends/{parent_name}/server_switching_rules
Replace an Server Switching Rule list
DELETE
/services/haproxy/configuration/backends/{parent_name}/server_switching_rules/{index}
Delete a Server Switching Rule
GET
/services/haproxy/configuration/backends/{parent_name}/server_switching_rules/{index}
Return one Server Switching Rule
POST
/services/haproxy/configuration/backends/{parent_name}/server_switching_rules/{index}
Add a new Server Switching Rule
PUT
/services/haproxy/configuration/backends/{parent_name}/server_switching_rules/{index}
Replace a Server Switching Rule
Filter 12
GET
/services/haproxy/configuration/backends/{parent_name}/filters
Return an array of all Filters
PUT
/services/haproxy/configuration/backends/{parent_name}/filters
Replace a Filter list
GET
/services/haproxy/configuration/frontends/{parent_name}/filters
Return an array of all Filters
PUT
/services/haproxy/configuration/frontends/{parent_name}/filters
Replace a Filter list
DELETE
/services/haproxy/configuration/backends/{parent_name}/filters/{index}
Delete a Filter
GET
/services/haproxy/configuration/backends/{parent_name}/filters/{index}
Return one Filter
POST
/services/haproxy/configuration/backends/{parent_name}/filters/{index}
Add a new Filter
PUT
/services/haproxy/configuration/backends/{parent_name}/filters/{index}
Replace a Filter
DELETE
/services/haproxy/configuration/frontends/{parent_name}/filters/{index}
Delete a Filter
GET
/services/haproxy/configuration/frontends/{parent_name}/filters/{index}
Return one Filter
POST
/services/haproxy/configuration/frontends/{parent_name}/filters/{index}
Add a new Filter
PUT
/services/haproxy/configuration/frontends/{parent_name}/filters/{index}
Replace a Filter
StickRule 6
GET
/services/haproxy/configuration/backends/{parent_name}/stick_rules
Return an array of all Stick Rules
PUT
/services/haproxy/configuration/backends/{parent_name}/stick_rules
Replace a Stick Rule list
DELETE
/services/haproxy/configuration/backends/{parent_name}/stick_rules/{index}
Delete a Stick Rule
GET
/services/haproxy/configuration/backends/{parent_name}/stick_rules/{index}
Return one Stick Rule
POST
/services/haproxy/configuration/backends/{parent_name}/stick_rules/{index}
Add a new Stick Rule
PUT
/services/haproxy/configuration/backends/{parent_name}/stick_rules/{index}
Replace a Stick Rule
LogTarget 36
GET
/services/haproxy/configuration/global/log_targets
Return an array of all Log Targets
PUT
/services/haproxy/configuration/global/log_targets
Replace a Log Target list
DELETE
/services/haproxy/configuration/global/log_targets/{index}
Delete a Log Target
GET
/services/haproxy/configuration/global/log_targets/{index}
Return one Log Target
POST
/services/haproxy/configuration/global/log_targets/{index}
Add a new Log Target
PUT
/services/haproxy/configuration/global/log_targets/{index}
Replace a Log Target
GET
/services/haproxy/configuration/backends/{parent_name}/log_targets
Return an array of all Log Targets
PUT
/services/haproxy/configuration/backends/{parent_name}/log_targets
Replace a Log Target list
GET
/services/haproxy/configuration/frontends/{parent_name}/log_targets
Return an array of all Log Targets
PUT
/services/haproxy/configuration/frontends/{parent_name}/log_targets
Replace a Log Target list
GET
/services/haproxy/configuration/defaults/{parent_name}/log_targets
Return an array of all Log Targets
PUT
/services/haproxy/configuration/defaults/{parent_name}/log_targets
Replace a Log Target list
GET
/services/haproxy/configuration/peers/{parent_name}/log_targets
Return an array of all Log Targets
PUT
/services/haproxy/configuration/peers/{parent_name}/log_targets
Replace a Log Target list
GET
/services/haproxy/configuration/log_forwards/{parent_name}/log_targets
Return an array of all Log Targets
PUT
/services/haproxy/configuration/log_forwards/{parent_name}/log_targets
Replace a Log Target list
DELETE
/services/haproxy/configuration/backends/{parent_name}/log_targets/{index}
Delete a Log Target
GET
/services/haproxy/configuration/backends/{parent_name}/log_targets/{index}
Return one Log Target
POST
/services/haproxy/configuration/backends/{parent_name}/log_targets/{index}
Add a new Log Target
PUT
/services/haproxy/configuration/backends/{parent_name}/log_targets/{index}
Replace a Log Target
DELETE
/services/haproxy/configuration/frontends/{parent_name}/log_targets/{index}
Delete a Log Target
GET
/services/haproxy/configuration/frontends/{parent_name}/log_targets/{index}
Return one Log Target
POST
/services/haproxy/configuration/frontends/{parent_name}/log_targets/{index}
Add a new Log Target
PUT
/services/haproxy/configuration/frontends/{parent_name}/log_targets/{index}
Replace a Log Target
DELETE
/services/haproxy/configuration/defaults/{parent_name}/log_targets/{index}
Delete a Log Target
GET
/services/haproxy/configuration/defaults/{parent_name}/log_targets/{index}
Return one Log Target
POST
/services/haproxy/configuration/defaults/{parent_name}/log_targets/{index}
Add a new Log Target
PUT
/services/haproxy/configuration/defaults/{parent_name}/log_targets/{index}
Replace a Log Target
DELETE
/services/haproxy/configuration/peers/{parent_name}/log_targets/{index}
Delete a Log Target
GET
/services/haproxy/configuration/peers/{parent_name}/log_targets/{index}
Return one Log Target
POST
/services/haproxy/configuration/peers/{parent_name}/log_targets/{index}
Add a new Log Target
PUT
/services/haproxy/configuration/peers/{parent_name}/log_targets/{index}
Replace a Log Target
DELETE
/services/haproxy/configuration/log_forwards/{parent_name}/log_targets/{index}
Delete a Log Target
GET
/services/haproxy/configuration/log_forwards/{parent_name}/log_targets/{index}
Return one Log Target
POST
/services/haproxy/configuration/log_forwards/{parent_name}/log_targets/{index}
Add a new Log Target
PUT
/services/haproxy/configuration/log_forwards/{parent_name}/log_targets/{index}
Replace a Log Target
ACL 24
GET
/services/haproxy/configuration/backends/{parent_name}/acls
Return an array of all ACL lines
PUT
/services/haproxy/configuration/backends/{parent_name}/acls
Replace an ACL list
GET
/services/haproxy/configuration/frontends/{parent_name}/acls
Return an array of all ACL lines
PUT
/services/haproxy/configuration/frontends/{parent_name}/acls
Replace an ACL list
GET
/services/haproxy/configuration/fcgi_apps/{parent_name}/acls
Return an array of all ACL lines
PUT
/services/haproxy/configuration/fcgi_apps/{parent_name}/acls
Replace an ACL list
GET
/services/haproxy/configuration/defaults/{parent_name}/acls
Return an array of all ACL lines
PUT
/services/haproxy/configuration/defaults/{parent_name}/acls
Replace an ACL list
DELETE
/services/haproxy/configuration/backends/{parent_name}/acls/{index}
Delete a ACL line
GET
/services/haproxy/configuration/backends/{parent_name}/acls/{index}
Return one ACL line
POST
/services/haproxy/configuration/backends/{parent_name}/acls/{index}
Add a new ACL line
PUT
/services/haproxy/configuration/backends/{parent_name}/acls/{index}
Replace a ACL line
DELETE
/services/haproxy/configuration/frontends/{parent_name}/acls/{index}
Delete a ACL line
GET
/services/haproxy/configuration/frontends/{parent_name}/acls/{index}
Return one ACL line
POST
/services/haproxy/configuration/frontends/{parent_name}/acls/{index}
Add a new ACL line
PUT
/services/haproxy/configuration/frontends/{parent_name}/acls/{index}
Replace a ACL line
DELETE
/services/haproxy/configuration/fcgi_apps/{parent_name}/acls/{index}
Delete a ACL line
GET
/services/haproxy/configuration/fcgi_apps/{parent_name}/acls/{index}
Return one ACL line
POST
/services/haproxy/configuration/fcgi_apps/{parent_name}/acls/{index}
Add a new ACL line
PUT
/services/haproxy/configuration/fcgi_apps/{parent_name}/acls/{index}
Replace a ACL line
DELETE
/services/haproxy/configuration/defaults/{parent_name}/acls/{index}
Delete a ACL line
GET
/services/haproxy/configuration/defaults/{parent_name}/acls/{index}
Return one ACL line
POST
/services/haproxy/configuration/defaults/{parent_name}/acls/{index}
Add a new ACL line
PUT
/services/haproxy/configuration/defaults/{parent_name}/acls/{index}
Replace a ACL line
Cache 5
GET
/services/haproxy/configuration/caches
Return an array of caches
POST
/services/haproxy/configuration/caches
Add a cache
DELETE
/services/haproxy/configuration/caches/{name}
Delete a cache
GET
/services/haproxy/configuration/caches/{name}
Return a cache
PUT
/services/haproxy/configuration/caches/{name}
Replace a cache
Resolver 5
GET
/services/haproxy/configuration/resolvers
Return an array of resolvers
POST
/services/haproxy/configuration/resolvers
Add a resolver
DELETE
/services/haproxy/configuration/resolvers/{name}
Delete a resolver
GET
/services/haproxy/configuration/resolvers/{name}
Return a resolver
PUT
/services/haproxy/configuration/resolvers/{name}
Replace a resolver
Nameserver 5
GET
/services/haproxy/configuration/nameservers
Return an array of nameservers
POST
/services/haproxy/configuration/nameservers
Add a nameserver
DELETE
/services/haproxy/configuration/nameservers/{name}
Delete a nameserver
GET
/services/haproxy/configuration/nameservers/{name}
Return a nameserver
PUT
/services/haproxy/configuration/nameservers/{name}
Replace a nameserver
Configuration 3
Raw HAProxy configuration management (advanced mode)
GET
/services/haproxy/configuration/raw
Return HAProxy configuration
POST
/services/haproxy/configuration/raw
Push new haproxy configuration
GET
/services/haproxy/configuration/version
Return a configuration version
CrtStore 5
GET
/services/haproxy/configuration/crt_stores
Return all the Certificate Stores
POST
/services/haproxy/configuration/crt_stores
Add a new Certificate Store
DELETE
/services/haproxy/configuration/crt_stores/{name}
Delete a Certificate Store
GET
/services/haproxy/configuration/crt_stores/{name}
Return a Certificate Store
PUT
/services/haproxy/configuration/crt_stores/{name}
Modify a Certificate Store
CrtLoad 5
GET
/services/haproxy/configuration/crt_stores/{crt_store}/crt_loads
Return an array of loaded certificates
POST
/services/haproxy/configuration/crt_stores/{crt_store}/crt_loads
Add a new certificate to load
DELETE
/services/haproxy/configuration/crt_stores/{crt_store}/crt_loads/{certificate}
Delete a certificate load entry
GET
/services/haproxy/configuration/crt_stores/{crt_store}/crt_loads/{certificate}
Return one certificate load entry
PUT
/services/haproxy/configuration/crt_stores/{crt_store}/crt_loads/{certificate}
Replace a certificate load entry
Traces 6
DELETE
/services/haproxy/configuration/traces
Delete the traces section
GET
/services/haproxy/configuration/traces
Return the traces section contents
POST
/services/haproxy/configuration/traces
Create the traces section
PUT
/services/haproxy/configuration/traces
Replace traces
DELETE
/services/haproxy/configuration/traces/entries
Delete a trace entry
POST
/services/haproxy/configuration/traces/entries
Add a new trace entry
LogProfile 5
GET
/services/haproxy/configuration/log_profiles
Return all the Log Profiles
POST
/services/haproxy/configuration/log_profiles
Add a new Log Profile
DELETE
/services/haproxy/configuration/log_profiles/{name}
Delete a Log Profile
GET
/services/haproxy/configuration/log_profiles/{name}
Return a Log Profile
PUT
/services/haproxy/configuration/log_profiles/{name}
Modify a Log Profile
ACL Runtime 7
GET
/services/haproxy/runtime/acls
Return an array of all ACL files
GET
/services/haproxy/runtime/acls/{id}
Return an ACL file
GET
/services/haproxy/runtime/acls/{parent_name}/entries
Return an ACL entries
POST
/services/haproxy/runtime/acls/{parent_name}/entries
Add entry to an ACL file
PUT
/services/haproxy/runtime/acls/{parent_name}/entries
Add a new ACL payload
DELETE
/services/haproxy/runtime/acls/{parent_name}/entries/{id}
Delete an ACL entry
GET
/services/haproxy/runtime/acls/{parent_name}/entries/{id}
Return an ACL entry
SSLRuntime 21
GET
/services/haproxy/runtime/ssl_ca_files
Return an array of all SSL CA files
POST
/services/haproxy/runtime/ssl_ca_files
Creates a new SSL CA file
DELETE
/services/haproxy/runtime/ssl_ca_files/{name}
Deletes a CA file
GET
/services/haproxy/runtime/ssl_ca_files/{name}
Return an SSL CA file
PUT
/services/haproxy/runtime/ssl_ca_files/{name}
Update the contents of a CA file
POST
/services/haproxy/runtime/ssl_ca_files/{name}/entries
Add a certificate to a CA file
GET
/services/haproxy/runtime/ssl_ca_files/{name}/entries/{index}
Return an SSL CA file cert entry
GET
/services/haproxy/runtime/ssl_certs
Return a list of SSL certificate files
POST
/services/haproxy/runtime/ssl_certs
Create a new SSL certificate file
DELETE
/services/haproxy/runtime/ssl_certs/{name}
Delete a certificate
GET
/services/haproxy/runtime/ssl_certs/{name}
Return one structured certificate
PUT
/services/haproxy/runtime/ssl_certs/{name}
Replace the contents of a certificate
GET
/services/haproxy/runtime/ssl_crl_files
Return an array of all the CRL files
POST
/services/haproxy/runtime/ssl_crl_files
Create a new CRL file
DELETE
/services/haproxy/runtime/ssl_crl_files/{name}
Delete a CRL file
GET
/services/haproxy/runtime/ssl_crl_files/{name}
Get the contents of a CRL file
PUT
/services/haproxy/runtime/ssl_crl_files/{name}
Replace the contents of a CRL file
GET
/services/haproxy/runtime/ssl_crt_lists
Get the list of all crt-list files
DELETE
/services/haproxy/runtime/ssl_crt_lists/entries
Delete an entry from a crt-list
GET
/services/haproxy/runtime/ssl_crt_lists/entries
Get all the entries inside a crt-list
POST
/services/haproxy/runtime/ssl_crt_lists/entries
Add an entry into a crt-list
StickTable 4
GET
/services/haproxy/runtime/stick_tables
Return Stick Tables
GET
/services/haproxy/runtime/stick_tables/{name}
Return Stick Table
GET
/services/haproxy/runtime/stick_tables/{parent_name}/entries
Return Stick Table Entries
POST
/services/haproxy/runtime/stick_tables/{parent_name}/entries
Set Entry to Stick Table
Maps 9
GET
/services/haproxy/runtime/maps
Return runtime map files
DELETE
/services/haproxy/runtime/maps/{name}
Remove all map entries from the map file
GET
/services/haproxy/runtime/maps/{name}
Return one runtime map file
PUT
/services/haproxy/runtime/maps/{name}
Add a new map payload
GET
/services/haproxy/runtime/maps/{parent_name}/entries
Return one map runtime entries
POST
/services/haproxy/runtime/maps/{parent_name}/entries
Adds an entry into the map file
DELETE
/services/haproxy/runtime/maps/{parent_name}/entries/{id}
Deletes all the map entries from the map by its id
GET
/services/haproxy/runtime/maps/{parent_name}/entries/{id}
Return one map runtime setting
PUT
/services/haproxy/runtime/maps/{parent_name}/entries/{id}
Replace the value corresponding to each id in a map
AcmeRuntime 2
GET
/services/haproxy/runtime/acme
ACME Status
PUT
/services/haproxy/runtime/acme
Renew ACME certificate
Storage 23
GET
/services/haproxy/storage/maps
Return a list of all managed map files
POST
/services/haproxy/storage/maps
Creates a managed storage map file with its entries
DELETE
/services/haproxy/storage/maps/{name}
Deletes a managed map file from disk
GET
/services/haproxy/storage/maps/{name}
Return the contents of one managed map file from disk
PUT
/services/haproxy/storage/maps/{name}
Replace contents of a managed map file on disk
GET
/services/haproxy/storage/ssl_certificates
Return all available SSL certificates on disk
POST
/services/haproxy/storage/ssl_certificates
Create SSL certificate
DELETE
/services/haproxy/storage/ssl_certificates/{name}
Delete SSL certificate from disk
GET
/services/haproxy/storage/ssl_certificates/{name}
Return one SSL certificate from disk
PUT
/services/haproxy/storage/ssl_certificates/{name}
Replace SSL certificates on disk
GET
/services/haproxy/storage/ssl_crt_lists
Return all available certificate lists on disk
POST
/services/haproxy/storage/ssl_crt_lists
Create a certificate list
DELETE
/services/haproxy/storage/ssl_crt_lists/{name}
Delete a certificate list from disk
GET
/services/haproxy/storage/ssl_crt_lists/{name}
Return one certificate list from disk
PUT
/services/haproxy/storage/ssl_crt_lists/{name}
Replace a certificate lists on disk
DELETE
/services/haproxy/storage/ssl_crt_lists/{name}/entries
Deletes an entry from CrtList file
GET
/services/haproxy/storage/ssl_crt_lists/{name}/entries
Returns all the entries in a CrtList
POST
/services/haproxy/storage/ssl_crt_lists/{name}/entries
Creates a new entry in a CrtList
GET
/services/haproxy/storage/general
Return a list of all managed general use files
POST
/services/haproxy/storage/general
Creates a managed storage general use file with contents
DELETE
/services/haproxy/storage/general/{name}
Deletes a managed general use file from disk
GET
/services/haproxy/storage/general/{name}
Return the contents of one managed general use file from disk
PUT
/services/haproxy/storage/general/{name}
Replace contents of a managed general use file on disk
Spoe 24
GET
/services/haproxy/spoe/spoe_files
Return all available SPOE files
POST
/services/haproxy/spoe/spoe_files
Creates SPOE file with its entries
DELETE
/services/haproxy/spoe/spoe_files/{name}
Delete SPOE file
GET
/services/haproxy/spoe/spoe_files/{name}
Return one SPOE file
GET
/services/haproxy/spoe/spoe_files/{parent_name}/scopes
Return an array of spoe scopes
POST
/services/haproxy/spoe/spoe_files/{parent_name}/scopes
Add a new spoe scope
DELETE
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{name}
Delete a SPOE scope
GET
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{name}
Return one SPOE scope
GET
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/agents
Return an array of spoe agents in one scope
POST
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/agents
Add a new spoe agent to scope
DELETE
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/agents/{name}
Delete a SPOE agent
GET
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/agents/{name}
Return a spoe agent
PUT
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/agents/{name}
Replace a SPOE agent
GET
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/messages
Return an array of spoe messages in one scope
POST
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/messages
Add a new spoe message to scope
DELETE
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/messages/{name}
Delete a spoe message
GET
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/messages/{name}
Return a spoe message
PUT
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/messages/{name}
Replace a spoe message
GET
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/groups
Return an array of SPOE groups
POST
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/groups
Add a new SPOE groups
DELETE
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/groups/{name}
Delete a SPOE groups
GET
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/groups/{name}
Return a SPOE groups
PUT
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/groups/{name}
Replace a SPOE groups
GET
/services/haproxy/spoe/{parent_name}/version
Return a SPOE configuration version
DeclareCapture 6
GET
/services/haproxy/configuration/frontends/{parent_name}/captures
Return an array of declare captures
PUT
/services/haproxy/configuration/frontends/{parent_name}/captures
Replace a declare capture list
DELETE
/services/haproxy/configuration/frontends/{parent_name}/captures/{index}
Delete a declare capture
GET
/services/haproxy/configuration/frontends/{parent_name}/captures/{index}
Return one declare capture
POST
/services/haproxy/configuration/frontends/{parent_name}/captures/{index}
Add a new declare capture
PUT
/services/haproxy/configuration/frontends/{parent_name}/captures/{index}
Replace a declare capture
SSLFrontUse 5
GET
/services/haproxy/configuration/frontends/{parent_name}/ssl_front_uses
Return an array of SSLFrontUses
POST
/services/haproxy/configuration/frontends/{parent_name}/ssl_front_uses
Add a new SSLFrontUse
DELETE
/services/haproxy/configuration/frontends/{parent_name}/ssl_front_uses/{index}
Delete an SSLFrontUse
GET
/services/haproxy/configuration/frontends/{parent_name}/ssl_front_uses/{index}
Return one SSLFrontUse
PUT
/services/haproxy/configuration/frontends/{parent_name}/ssl_front_uses/{index}
Replace an SSLFrontUse
ForceBeSwitch 5
GET
/services/haproxy/configuration/frontends/{parent_name}/force_be_switches
Return an array of force-be-switch rules
POST
/services/haproxy/configuration/frontends/{parent_name}/force_be_switches
Add a new force-be-switch rule
DELETE
/services/haproxy/configuration/frontends/{parent_name}/force_be_switches/{index}
Delete a force-be-switch rule
GET
/services/haproxy/configuration/frontends/{parent_name}/force_be_switches/{index}
Return one force-be-switch rule
PUT
/services/haproxy/configuration/frontends/{parent_name}/force_be_switches/{index}
Replace a force-be-switch rule
Acme 5
GET
/services/haproxy/configuration/acme
Return all the ACME providers
POST
/services/haproxy/configuration/acme
Add a new Acme provider
DELETE
/services/haproxy/configuration/acme/{name}
Delete an ACME provider
GET
/services/haproxy/configuration/acme/{name}
Find an ACME provider
PUT
/services/haproxy/configuration/acme/{name}
Modify an ACME provider
HealthCheck 5
GET
/services/haproxy/configuration/healthchecks
Return an array of healthchecks
POST
/services/haproxy/configuration/healthchecks
Add a healthcheck
DELETE
/services/haproxy/configuration/healthchecks/{name}
Delete a healthcheck
GET
/services/haproxy/configuration/healthchecks/{name}
Return a healthcheck
PUT
/services/haproxy/configuration/healthchecks/{name}
Replace a healthcheck
Schemas 232
The contract defines 232 schemas that model the data the API accepts and returns. The most detailed are defaults_base (114 properties), server_params (111 properties), backend_base (90 properties), bind_params (87 properties). Each schema is shown below with its type and property counts.
fcgi_app
object
App with all its children resources
fcgi_app_base
object
HAProxy FastCGI application configuration
12 properties
2 required
fcgi_apps
array
fcgi_set_param
object
Sets a FastCGI parameter to pass to this application. Its value, defined by can take a formatted string, the same as the log directive. Optionally, you can fol…
4 properties
fcgi_pass_header
object
Specifies the name of a request header to pass to the FastCGI application. Optionally, you can follow it with an ACL-based condition, in which case the FastCGI…
3 properties
fcgi_log_stderr
object
Enables logging of STDERR messages that the FastCGI application reports. It is an optional setting. By default, HAProxy Enterprise ignores STDERR messages.
8 properties
bind_params
object
87 properties
server_params
object
111 properties
site
object
Site configuration. Sites are considered as one service and all farms connected to that service. Farms are connected to service using use-backend and defaultba…
3 properties
1 required
sites
array
Sites array. Sites are considered as one service and all farms connected to that service. Farms are connected to service using use-backend and defaultbackend d…
environment_options
object
4 properties
performance_options
object
24 properties
ssl_options
object
29 properties
tune_options
object
60 properties
tune_quic_options
object
10 properties
tune_vars_options
object
5 properties
tune_zlib_options
object
2 properties
tune_ssl_options
object
11 properties
tune_lua_options
object
10 properties
tune_buffer_options
object
15 properties
debug_options
object
4 properties
http_client_options
object
7 properties
ocsp_update_options
object
5 properties
lua_options
object
3 properties
wurfl_options
object
5 properties
device_atlas_options
object
4 properties
fifty_one_degrees_options
object
4 properties
global
object
Frontend with all its children resources
global_base
object
HAProxy global configuration
78 properties
defaults
object
Defaults with all its children resources
defaults_base
object
HAProxy defaults configuration
114 properties
1 required
defaults_sections
array
HAProxy defaults sections array
frontend
object
Frontend with all its children resources
frontend_base
object
HAProxy frontend configuration
71 properties
1 required
frontends
array
HAProxy frontends array
backend
object
Backend with all its children resources
backend_base
object
HAProxy backend configuration
90 properties
1 required
backends
array
HAProxy backends array
healthcheck
object
HealthCheck with all it's children resources
healthcheck_base
object
HealthCheck with all it's children resources
6 properties
1 required
healthchecks
array
HAProxy healthchecks array
ring
object
Ring with all its children resources
ring_base
object
HAProxy ring configuration
8 properties
1 required
rings
array
HAProxy rings array
dgram_bind
object
HAProxy log forward dgram bind configuration
8 properties
1 required
dgram_binds
array
HAProxy dgram bind array
log_forward
object
LogForward with all its children resources
log_forward_base
object
HAProxy log forward configuration
7 properties
1 required
log_forwards
array
HAProxy log forwards array
userlist
object
Userlist with all its children resources
userlist_base
object
HAProxy configuration of access control
2 properties
1 required
userlists
array
HAProxy userlists array
user
object
HAProxy userlist user
5 properties
3 required
users
array
HAProxy userlist users array
group
object
HAProxy userlist group
3 properties
1 required
groups
array
HAProxy userlist groups array
mailers_section
object
MailersSection with all its children resources
mailers_section_base
object
A list of SMTP servers used by HAProxy to send emails.
3 properties
1 required
mailers_sections
array
HAProxy mailerssection array
mailer_entry
object
Mailer entry of a Mailers section
4 properties
3 required
mailer_entries
array
HAProxy mailer entries
peer_section
object
Peer Section with all its children resources
peer_section_base
object
HAProxy peersection configuration
7 properties
1 required
peer_sections
array
HAProxy peersection array
peer_entry
object
Peer Entry from peers table
5 properties
3 required
peer_entries
array
HAProxy peer entries array
http_errors_section
object
A globally declared group of HTTP errors
3 properties
2 required
http_errors_sections
array
An array of HAProxy http-error sections
bind
HAProxy frontend bind configuration
binds
array
HAProxy frontend binds array (corresponds to bind directives)
server
HAProxy backend server configuration
servers
array
HAProxy backend servers array
server_template
Set a template to initialize servers with shared parameters.
server_templates
array
HAProxy backend server templates array
config_stick_table
object
11 properties
http_request_rule
object
HAProxy HTTP request rule configuration (corresponds to http-request directives)
74 properties
1 required
http_request_rules
array
HAProxy HTTP request rules array (corresponds to http-request directives)
http_response_rule
object
HAProxy HTTP response rule configuration (corresponds to http-response directives)
60 properties
1 required
http_response_rules
array
HAProxy HTTP response rules array (corresponds to http-response directives)
http_after_response_rule
object
HAProxy HTTP after response rule configuration (corresponds to http-after-response directives)
31 properties
1 required
http_after_response_rules
array
HAProxy HTTP after response rules array (corresponds to http-after-response directives)
http_error_rule
object
HAProxy HTTP error rule configuration (corresponds to http-error directives)
7 properties
2 required
http_error_rules
array
HAProxy HTTP error rules array (corresponds to http-error directives)
http_check
object
35 properties
1 required
http_checks
array
tcp_request_rule
object
HAProxy TCP Request Rule configuration (corresponds to tcp-request)
38 properties
1 required
tcp_request_rules
array
HAProxy TCP request rules array (corresponds to tcp-request directive)
tcp_response_rule
object
HAProxy TCP Response Rule configuration (corresponds to tcp-response)
27 properties
1 required
tcp_response_rules
array
HAProxy TCP response rules array (corresponds to tcp-response directive)
tcp_check
object
32 properties
1 required
tcp_checks
array
quic_initial_rule
object
QUIC Initial configuration
4 properties
1 required
quic_initial_rules
array
backend_switching_rule
object
HAProxy backend switching rule configuration (corresponds to usebackend directive)
4 properties
1 required
backend_switching_rules
array
HAProxy backend switching rules array (corresponds to usebackend directives)
server_switching_rule
object
HAProxy server switching rule configuration (corresponds to use-server directive)
4 properties
1 required
server_switching_rules
array
HAProxy backend server switching rules array (corresponds to use-server directives)
filter
object
HAProxy filters
20 properties
1 required
filters
array
HAProxy filters array (corresponds to filter directive)
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
filter_sequences
array
HAProxy filter sequences array (corresponds to filter-sequence directive)
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
stick_rules
array
HAProxy backend stick rules array (corresponds to stick store-request, stick match, stick on, stick store-response)
log_target
object
Per-instance logging of events and traffic.
12 properties
log_targets
array
HAProxy log target array (corresponds to log 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
acls
array
HAProxy ACL lines array (corresponds to acl directives)
native_stats
object
HAProxy stats array
3 properties
native_stat
object
Current stats for one object.
4 properties
native_stat_stats
object
80 properties
stats_options
object
17 properties
stats_http_request
object
4 properties
1 required
stats_auth
object
2 properties
2 required
error
object
API Error
2 properties
2 required
endpoint
object
Endpoint definition
3 properties
endpoints
array
Collection of endpoints
process_info
object
General HAProxy process information
3 properties
process_info_item
object
60 properties
transaction
object
HAProxy configuration transaction
3 properties
transactions
array
Configuration transactions array
spoe_transaction
object
SPOE configuration transaction
3 properties
spoe_transactions
array
SPOE Configuration transactions array
info
object
General API, OS and hardware information
2 properties
health
object
1 property
reload
object
HAProxy reload
4 properties
reloads
array
HAProxy reloads array
runtime_add_server
object
Settable properties when adding a new server using HAProxy's runtime.
74 properties
runtime_server
object
Runtime transient server properties
26 properties
runtime_servers
array
HAProxy runtime servers array
stick_table
object
Stick Table Information
5 properties
stick_tables
array
Array of runtime stick tables
stick_table_entry
object
One entry in stick table
30 properties
stick_table_entries
array
Entries of one runtime stick table
map
object
Map File
5 properties
maps
array
Array of runtime map files
map_entry
object
One Map Entry
3 properties
map_entries
array
Entries of one runtime map
ssl_certificate
object
A file containing one or more SSL/TLS certificates and keys
20 properties
ssl_certificates
array
Array of ssl certificate files
ssl_crt_list_file
object
A file referencing one or more certificates with their configuration.
4 properties
ssl_crt_list_files
array
List of SSL certificate list files (crt-list)
ssl_ca_file
object
A file containing one or more SSL/TLS certificates and keys
3 properties
ssl_ca_files
array
Array of SSL CA files
ssl_crl
object
A file containing one or more SSL/TLS CRLs
3 properties
ssl_crls
array
Array of ssl crl files
ssl_crl_entry
object
A certificate revocation list entry.
8 properties
ssl_crl_entries
array
ssl_certificate_id
object
SSL Certificate ID
3 properties
ssl_crt_list
object
SSL Crt List file
1 property
ssl_crt_lists
array
Array of SSL Crt List
ssl_crt_list_entry
object
SSL Crt List Entry
4 properties
ssl_crt_list_entries
array
Array of SSL Crt List Entry
ssl_ocsp_response
object
SSL OCSP Response
7 properties
ssl_ocsp_update
object
SSL OCSP Update
8 properties
ssl_providers
object
SSL Providers
1 property
acme_certificate_status
object
Status of a single ACME certificate from runtime.
7 properties
acme_status
array
Status of all the ACME certificates from runtime.
acl_file
object
ACL File
3 properties
acl_files
array
Array of runtime acl files
acl_file_entry
object
One ACL File Entry
2 properties
acl_files_entries
array
Array of entries of one runtime acl file
general_file
object
General use file
5 properties
general_files
array
Array of general use files
balance
object
13 properties
1 required
hash_type
object
3 properties
persist_rule
object
2 properties
1 required
forwardfor
object
4 properties
1 required
forwarded
object
Controls insertion of the HTTP Forwarded header field.
12 properties
1 required
default_server
httpchk_params
object
4 properties
redispatch
object
2 properties
1 required
errorfile
object
2 properties
errorfiles
object
3 properties
cookie
object
13 properties
1 required
capture
object
3 properties
2 required
captures
array
resolver
object
Resolver with all its children resources
resolver_base
object
Runtime DNS configuration
13 properties
1 required
resolvers
array
HAProxy resolvers array
nameserver
object
Nameserver used in Runtime DNS configuration
4 properties
2 required
nameservers
array
Nameservers array
cache
object
HAPRoxy Cache section
7 properties
1 required
caches
array
HAProxy caches array
awsFilters
object
2 properties
2 required
awsRegion
object
AWS region configuration
14 properties
5 required
awsRegions
array
AWS regions array
consul
object
Consul server configuration
19 properties
4 required
consuls
array
Consuls array
monitor_uri
string
monitor_fail
object
2 properties
2 required
originalto
object
3 properties
1 required
use_small_buffers
object
Enables support for small buffers for the given categories.
4 properties
1 required
smtpchk_params
object
2 properties
mysql_check_params
object
2 properties
pgsql_check_params
object
1 property
spoe_files
array
SPOE files
spoe_scope
string
SPOE scope name
spoe_scopes
array
All SPOE Scopes
spoe_agent
object
SPOE agent configuration
24 properties
1 required
spoe_agents
array
SPOE Agents of one scope in SPOE file
spoe_message
object
SPOE message section configuration
4 properties
1 required
spoe_messages
array
SPOE Messages of one scope in SPOE file
spoe_group
object
SPOE group section configuration
2 properties
1 required
spoe_groups
array
SPOE Groups of one scope in SPOE file
return_header
object
2 properties
2 required
compression
object
10 properties
source
object
8 properties
1 required
email_alert
object
Send emails for important log messages.
6 properties
3 required
email_alerts
array
Email Alerts array (corresponds to email-alert directives)
errorloc
object
3 properties
2 required
default_bind
HAProxy default bind configuration
table
object
10 properties
1 required
tables
array
HAProxy table array
http_codes
object
1 property
1 required
crt_store
Storage mechanism to load and store certificates used in the configuration
crt_stores
array
List of Certificate Stores
crt_store_base
object
Storage mechanism to load and store certificates used in the configuration
4 properties
1 required
crt_load
object
Loads a certificate from a store with options
10 properties
1 required
crt_loads
array
List of certificates to load from a Certificate Store
traces
object
Trace events configuration
2 properties
trace_entry
object
Configure a trace event
2 properties
1 required
trace_entries
array
list of entries in a traces section
log_profile
object
Defines a logging profile for one or more steps.
4 properties
1 required
log_profiles
array
List of Logging Profiles
log_profile_step
object
Defines what to log for a given step.
5 properties
1 required
log_profile_steps
array
List of steps where to override the logging.
ssl_front_use
object
Assign a certificate to the current frontend
23 properties
1 required
ssl_front_uses
array
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
force_be_switches
array
acme_provider
object
Define an ACME provider to generate certificates automatically
17 properties
2 required
acme_providers
array
List of ACME sections.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HAProxy 2
Other APIs HAProxy publishes across the network.
HAProxy Runtime API
HAProxy Kubernetes Ingress Controller
#Configuration#Load Balancing#REST API
Where this information came from
This is an independent, third-party profile of HAProxy Data Plane 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.