HAProxy Data Plane API

HAProxy Data Plane API

API for editing and managing haproxy instances. Provides process information, configuration management, haproxy stats and logs.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

API for editing and managing haproxy instances. Provides process information, configuration management,
haproxy stats and logs.

Endpoints 180

Discovery

  • GETReturn list of root endpoints/Returns a list of root endpoints.
  • GETReturn cluster data/clusterReturns cluster data
  • GETReturn list of service endpoints/servicesReturns a list of API managed services endpoints.
  • GETReturn list of HAProxy related endpoints/services/haproxyReturns a list of HAProxy related endpoints.
  • GETReturn list of HAProxy stats endpoints/services/haproxy/statsReturns a list of HAProxy stats endpoints.
  • GETReturn list of HAProxy advanced configuration endpoints/services/haproxy/configurationReturns a list of endpoints to be used for advanced configuration of HAProxy objects.
  • GETReturn list of HAProxy advanced runtime endpoints/services/haproxy/runtimeReturns a list of endpoints to be used for advanced runtime settings of HAProxy objects.

Information

  • GETReturn API, hardware and OS information/infoReturn API, hardware and OS information
  • GETReturn HAProxy process information/services/haproxy/runtime/infoReturn HAProxy process information

Specification

  • GETData Plane API Specification/specificationReturn Data Plane API OpenAPI specification

Transactions

  • GETReturn list of HAProxy configuration transactions./services/haproxy/transactions?status=failedReturns a list of HAProxy configuration transactions. Transactions can be filtered by their status.
  • POSTStart a new transaction/services/haproxy/transactions?version=0Starts a new transaction and returns it's id
  • GETReturn one HAProxy configuration transactions/services/haproxy/transactions/:idReturns one HAProxy configuration transactions.
  • PUTCommit transaction/services/haproxy/transactions/:id?force_reload=falseCommit transaction, execute all operations in transaction and return msg
  • DELETEDelete a transaction/services/haproxy/transactions/:idDeletes a transaction.

Reloads

  • GETReturn list of HAProxy Reloads./services/haproxy/reloadsReturns a list of HAProxy reloads.
  • GETReturn one HAProxy reload status/services/haproxy/reloads/:idReturns one HAProxy reload status.

Sites

  • GETReturn an array of sites/services/haproxy/sites?transaction_id=stringReturns an array of all configured sites.
  • POSTAdd a site/services/haproxy/sites?transaction_id=string&version=0&force_reload=falseAdds a new site to the configuration file.
  • GETReturn a site/services/haproxy/sites/:name?transaction_id=stringReturns one site configuration by it's name.
  • PUTReplace a site/services/haproxy/sites/:name?transaction_id=string&version=0&force_reload=falseReplaces a site configuration by it's name.
  • DELETEDelete a site/services/haproxy/sites/:name?transaction_id=string&version=0&force_reload=falseDeletes a site from the configuration by it's name.

Stats

  • GETGets stats/services/haproxy/stats/native?type=frontend&name=string&parent=stringGetting stats from the HAProxy.

Global

  • GETReturn a global part of configuration/services/haproxy/configuration/global?transaction_id=stringReturns global part of configuration.
  • PUTReplace global/services/haproxy/configuration/global?transaction_id=string&version=0&force_reload=falseReplace global part of config

Defaults

  • GETReturn defaults part of configuration/services/haproxy/configuration/defaults?transaction_id=stringReturns defaults part of configuration.
  • PUTReplace defaults/services/haproxy/configuration/defaults?transaction_id=string&version=0&force_reload=falseReplace defaults part of config

Frontend

  • GETReturn an array of frontends/services/haproxy/configuration/frontends?transaction_id=stringReturns an array of all configured frontends.
  • POSTAdd a frontend/services/haproxy/configuration/frontends?transaction_id=string&version=0&force_reload=falseAdds a new frontend to the configuration file.
  • GETReturn a frontend/services/haproxy/configuration/frontends/:name?transaction_id=stringReturns one frontend configuration by it's name.
  • PUTReplace a frontend/services/haproxy/configuration/frontends/:name?transaction_id=string&version=0&force_reload=falseReplaces a frontend configuration by it's name.
  • DELETEDelete a frontend/services/haproxy/configuration/frontends/:name?transaction_id=string&version=0&force_reload=falseDeletes a frontend from the configuration by it's name.

Backend

  • GETReturn an array of backends/services/haproxy/configuration/backends?transaction_id=stringReturns an array of all configured backends.
  • POSTAdd a backend/services/haproxy/configuration/backends?transaction_id=string&version=0&force_reload=falseAdds a new backend to the configuration file.
  • GETReturn a backend/services/haproxy/configuration/backends/:name?transaction_id=stringReturns one backend configuration by it's name.
  • PUTReplace a backend/services/haproxy/configuration/backends/:name?transaction_id=string&version=0&force_reload=falseReplaces a backend configuration by it's name.
  • DELETEDelete a backend/services/haproxy/configuration/backends/:name?transaction_id=string&version=0&force_reload=falseDeletes a backend from the configuration by it's name.

Bind

  • GETReturn an array of binds/services/haproxy/configuration/binds?frontend=string&transaction_id=stringReturns an array of all binds that are configured in specified frontend.
  • POSTAdd a new bind/services/haproxy/configuration/binds?frontend=string&transaction_id=string&version=0&force_reload=falseAdds a new bind in the specified frontend in the configuration file.
  • GETReturn one bind/services/haproxy/configuration/binds/:name?frontend=string&transaction_id=stringReturns one bind configuration by it's name in the specified frontend.
  • PUTReplace a bind/services/haproxy/configuration/binds/:name?frontend=string&transaction_id=string&version=0&force_reload=falseReplaces a bind configuration by it's name in the specified frontend.
  • DELETEDelete a bind/services/haproxy/configuration/binds/:name?frontend=string&transaction_id=string&version=0&force_reload=falseDeletes a bind configuration by it's name in the specified frontend.

Server

  • GETReturn an array of servers/services/haproxy/configuration/servers?backend=string&transaction_id=stringReturns an array of all servers that are configured in specified backend.
  • POSTAdd a new server/services/haproxy/configuration/servers?backend=string&transaction_id=string&version=0&force_reload=falseAdds a new server in the specified backend in the configuration file.
  • GETReturn one server/services/haproxy/configuration/servers/:name?backend=string&transaction_id=stringReturns one server configuration by it's name in the specified backend.
  • PUTReplace a server/services/haproxy/configuration/servers/:name?backend=string&transaction_id=string&version=0&force_reload=falseReplaces a server configuration by it's name in the specified backend.
  • DELETEDelete a server/services/haproxy/configuration/servers/:name?backend=string&transaction_id=string&version=0&force_reload=falseDeletes a server configuration by it's name in the specified backend.
  • GETReturn an array of runtime servers' settings/services/haproxy/runtime/servers?backend=stringReturns an array of all servers' runtime settings.
  • GETReturn one server runtime settings/services/haproxy/runtime/servers/:name?backend=stringReturns one server runtime settings by it's name in the specified backend.
  • PUTReplace server transient settings/services/haproxy/runtime/servers/:name?backend=stringReplaces a server transient settings by it's name in the specified backend.

Configuration

  • GETReturn HAProxy configuration/services/haproxy/configuration/raw?transaction_id=string&version=0Returns HAProxy configuration file in plain text
  • POSTPush new haproxy configuration/services/haproxy/configuration/raw?skip_version=false&skip_reload=false&only_validate=false&version=0&force_reload=falsePush a new haproxy configuration file in plain text
  • GETReturn a configuration version/services/haproxy/configuration/version?transaction_id=stringReturns configuration version.

TCPRequestRule

  • GETReturn an array of all TCP Request Rules/services/haproxy/configuration/tcp_request_rules?parent_name=string&parent_type=frontend&transaction_id=stringReturns all TCP Request Rules that are configured in specified parent and parent type.
  • POSTAdd a new TCP Request Rule/services/haproxy/configuration/tcp_request_rules?parent_name=string&parent_type=frontend&transaction_id=string&version=0&force_reload=falseAdds a new TCP Request Rule of the specified type in the specified parent.
  • GETReturn one TCP Request Rule/services/haproxy/configuration/tcp_request_rules/:index?parent_name=string&parent_type=frontend&transaction_id=stringReturns one TCP Request Rule configuration by it's index in the specified parent.
  • PUTReplace a TCP Request Rule/services/haproxy/configuration/tcp_request_rules/:index?parent_name=string&parent_type=frontend&transaction_id=string&version=0&force_reload=falseReplaces a TCP Request Rule configuration by it's index in the specified parent.
  • DELETEDelete a TCP Request Rule/services/haproxy/configuration/tcp_request_rules/:index?parent_name=string&parent_type=frontend&transaction_id=string&version=0&force_reload=falseDeletes a TCP Request Rule configuration by it's index from the specified parent.

HTTPRequestRule

  • GETReturn an array of all HTTP Request Rules/services/haproxy/configuration/http_request_rules?parent_name=string&parent_type=frontend&transaction_id=stringReturns all HTTP Request Rules that are configured in specified parent.
  • POSTAdd a new HTTP Request Rule/services/haproxy/configuration/http_request_rules?parent_name=string&parent_type=frontend&transaction_id=string&version=0&force_reload=falseAdds a new HTTP Request Rule of the specified type in the specified parent.
  • GETReturn one HTTP Request Rule/services/haproxy/configuration/http_request_rules/:index?parent_name=string&parent_type=frontend&transaction_id=stringReturns one HTTP Request Rule configuration by it's index in the specified parent.
  • PUTReplace a HTTP Request Rule/services/haproxy/configuration/http_request_rules/:index?parent_name=string&parent_type=frontend&transaction_id=string&version=0&force_reload=falseReplaces a HTTP Request Rule configuration by it's index in the specified parent.
  • DELETEDelete a HTTP Request Rule/services/haproxy/configuration/http_request_rules/:index?parent_name=string&parent_type=frontend&transaction_id=string&version=0&force_reload=falseDeletes a HTTP Request Rule configuration by it's index from the specified parent.

HTTPResponseRule

  • GETReturn an array of all HTTP Response Rules/services/haproxy/configuration/http_response_rules?parent_name=string&parent_type=frontend&transaction_id=stringReturns all HTTP Response Rules that are configured in specified parent.
  • POSTAdd a new HTTP Response Rule/services/haproxy/configuration/http_response_rules?parent_name=string&parent_type=frontend&transaction_id=string&version=0&force_reload=falseAdds a new HTTP Response Rule of the specified type in the specified parent.
  • GETReturn one HTTP Response Rule/services/haproxy/configuration/http_response_rules/:index?parent_name=string&parent_type=frontend&transaction_id=stringReturns one HTTP Response Rule configuration by it's index in the specified parent.
  • PUTReplace a HTTP Response Rule/services/haproxy/configuration/http_response_rules/:index?parent_name=string&parent_type=frontend&transaction_id=string&version=0&force_reload=falseReplaces a HTTP Response Rule configuration by it's index in the specified parent.
  • DELETEDelete a HTTP Response Rule/services/haproxy/configuration/http_response_rules/:index?parent_name=string&parent_type=frontend&transaction_id=string&version=0&force_reload=falseDeletes a HTTP Response Rule configuration by it's index from the specified parent.

BackendSwitchingRule

  • GETReturn an array of all Backend Switching Rules/services/haproxy/configuration/backend_switching_rules?frontend=string&transaction_id=stringReturns all Backend Switching Rules that are configured in specified frontend.
  • POSTAdd a new Backend Switching Rule/services/haproxy/configuration/backend_switching_rules?frontend=string&transaction_id=string&version=0&force_reload=falseAdds a new Backend Switching Rule of the specified type in the specified frontend.
  • GETReturn one Backend Switching Rule/services/haproxy/configuration/backend_switching_rules/:index?frontend=string&transaction_id=stringReturns one Backend Switching Rule configuration by it's index in the specified frontend.
  • PUTReplace a Backend Switching Rule/services/haproxy/configuration/backend_switching_rules/:index?frontend=string&transaction_id=string&version=0&force_reload=falseReplaces a Backend Switching Rule configuration by it's index in the specified frontend.
  • DELETEDelete a Backend Switching Rule/services/haproxy/configuration/backend_switching_rules/:index?frontend=string&transaction_id=string&version=0&force_reload=falseDeletes a Backend Switching Rule configuration by it's index from the specified frontend.

ServerSwitchingRule

  • GETReturn an array of all Server Switching Rules/services/haproxy/configuration/server_switching_rules?backend=string&transaction_id=stringReturns all Backend Switching Rules that are configured in specified backend.
  • POSTAdd a new Server Switching Rule/services/haproxy/configuration/server_switching_rules?backend=string&transaction_id=string&version=0&force_reload=falseAdds a new Server Switching Rule of the specified type in the specified backend.
  • GETReturn one Server Switching Rule/services/haproxy/configuration/server_switching_rules/:index?backend=string&transaction_id=stringReturns one Server Switching Rule configuration by it's index in the specified backend.
  • PUTReplace a Server Switching Rule/services/haproxy/configuration/server_switching_rules/:index?backend=string&transaction_id=string&version=0&force_reload=falseReplaces a Server Switching Rule configuration by it's index in the specified backend.
  • DELETEDelete a Server Switching Rule/services/haproxy/configuration/server_switching_rules/:index?backend=string&transaction_id=string&version=0&force_reload=falseDeletes a Server Switching Rule configuration by it's index from the specified backend.

TCPResponseRule

  • GETReturn an array of all TCP Response Rules/services/haproxy/configuration/tcp_response_rules?backend=string&transaction_id=stringReturns all TCP Response Rules that are configured in specified backend.
  • POSTAdd a new TCP Response Rule/services/haproxy/configuration/tcp_response_rules?backend=string&transaction_id=string&version=0&force_reload=falseAdds a new TCP Response Rule of the specified type in the specified backend.
  • GETReturn one TCP Response Rule/services/haproxy/configuration/tcp_response_rules/:index?backend=string&transaction_id=stringReturns one TCP Response Rule configuration by it's index in the specified backend.
  • PUTReplace a TCP Response Rule/services/haproxy/configuration/tcp_response_rules/:index?backend=string&transaction_id=string&version=0&force_reload=falseReplaces a TCP Response Rule configuration by it's Index in the specified backend.
  • DELETEDelete a TCP Response Rule/services/haproxy/configuration/tcp_response_rules/:index?backend=string&transaction_id=string&version=0&force_reload=falseDeletes a TCP Response Rule configuration by it's index from the specified backend.

Filter

  • GETReturn an array of all Filters/services/haproxy/configuration/filters?parent_name=string&parent_type=frontend&transaction_id=stringReturns all Filters that are configured in specified parent.
  • POSTAdd a new Filter/services/haproxy/configuration/filters?parent_name=string&parent_type=frontend&transaction_id=string&version=0&force_reload=falseAdds a new Filter of the specified type in the specified parent.
  • GETReturn one Filter/services/haproxy/configuration/filters/:index?parent_name=string&parent_type=frontend&transaction_id=stringReturns one Filter configuration by it's index in the specified parent.
  • PUTReplace a Filter/services/haproxy/configuration/filters/:index?parent_name=string&parent_type=frontend&transaction_id=string&version=0&force_reload=falseReplaces a Filter configuration by it's index in the specified parent.
  • DELETEDelete a Filter/services/haproxy/configuration/filters/:index?parent_name=string&parent_type=frontend&transaction_id=string&version=0&force_reload=falseDeletes a Filter configuration by it's index from the specified parent.

StickRule

  • GETReturn an array of all Stick Rules/services/haproxy/configuration/stick_rules?backend=string&transaction_id=stringReturns all Stick Rules that are configured in specified backend.
  • POSTAdd a new Stick Rule/services/haproxy/configuration/stick_rules?backend=string&transaction_id=string&version=0&force_reload=falseAdds a new Stick Rule of the specified type in the specified backend.
  • GETReturn one Stick Rule/services/haproxy/configuration/stick_rules/:index?backend=string&transaction_id=stringReturns one Stick Rule configuration by it's index in the specified backend.
  • PUTReplace a Stick Rule/services/haproxy/configuration/stick_rules/:index?backend=string&transaction_id=string&version=0&force_reload=falseReplaces a Stick Rule configuration by it's index in the specified backend.
  • DELETEDelete a Stick Rule/services/haproxy/configuration/stick_rules/:index?backend=string&transaction_id=string&version=0&force_reload=falseDeletes a Stick Rule configuration by it's index from the specified backend.

StickTable

  • GETReturn Stick Tables/services/haproxy/runtime/stick_tables?process=0Returns an array of all stick tables.
  • GETReturn Stick Table/services/haproxy/runtime/stick_tables/:name?process=0Returns one stick table from runtime.
  • GETReturn Stick Table Entries/services/haproxy/runtime/stick_table_entries?stick_table=string&process=0&filter=string&key=string&count=0&offset=0Returns an array of all entries in a given stick tables.

LogTarget

  • GETReturn an array of all Log Targets/services/haproxy/configuration/log_targets?parent_name=string&parent_type=frontend&transaction_id=stringReturns all Log Targets that are configured in specified parent.
  • POSTAdd a new Log Target/services/haproxy/configuration/log_targets?parent_name=string&parent_type=frontend&transaction_id=string&version=0&force_reload=falseAdds a new Log Target of the specified type in the specified parent.
  • GETReturn one Log Target/services/haproxy/configuration/log_targets/:index?parent_name=string&parent_type=frontend&transaction_id=stringReturns one Log Target configuration by it's index in the specified parent.
  • PUTReplace a Log Target/services/haproxy/configuration/log_targets/:index?parent_name=string&parent_type=frontend&transaction_id=string&version=0&force_reload=falseReplaces a Log Target configuration by it's index in the specified parent.
  • DELETEDelete a Log Target/services/haproxy/configuration/log_targets/:index?parent_name=string&parent_type=frontend&transaction_id=string&version=0&force_reload=falseDeletes a Log Target configuration by it's index from the specified parent.

ACL

  • GETReturn an array of all ACL lines/services/haproxy/configuration/acls?parent_name=string&parent_type=frontend&transaction_id=stringReturns all ACL lines that are configured in specified parent.
  • POSTAdd a new ACL line/services/haproxy/configuration/acls?parent_name=string&parent_type=frontend&transaction_id=string&version=0&force_reload=falseAdds a new ACL line of the specified type in the specified parent.
  • GETReturn one ACL line/services/haproxy/configuration/acls/:index?parent_name=string&parent_type=frontend&transaction_id=stringReturns one ACL line configuration by it's index in the specified parent.
  • PUTReplace a ACL line/services/haproxy/configuration/acls/:index?parent_name=string&parent_type=frontend&transaction_id=string&version=0&force_reload=falseReplaces a ACL line configuration by it's index in the specified parent.
  • DELETEDelete a ACL line/services/haproxy/configuration/acls/:index?parent_name=string&parent_type=frontend&transaction_id=string&version=0&force_reload=falseDeletes a ACL line configuration by it's index from the specified parent.

Resolver

  • GETReturn an array of resolvers/services/haproxy/configuration/resolvers?transaction_id=stringReturns an array of all configured resolvers.
  • POSTAdd a resolver/services/haproxy/configuration/resolvers?transaction_id=string&version=0&force_reload=falseAdds a new resolver section to the configuration file.
  • GETReturn a resolver/services/haproxy/configuration/resolvers/:name?transaction_id=stringReturns one resolver section configuration by it's name.
  • PUTReplace a resolver/services/haproxy/configuration/resolvers/:name?transaction_id=string&version=0&force_reload=falseReplaces a resolver configuration by it's name.
  • DELETEDelete a resolver/services/haproxy/configuration/resolvers/:name?transaction_id=string&version=0&force_reload=falseDeletes a resolver from the configuration by it's name.

Nameserver

  • GETReturn an array of nameservers/services/haproxy/configuration/nameservers?resolver=string&transaction_id=stringReturns an array of all configured nameservers.
  • POSTAdd a nameserver/services/haproxy/configuration/nameservers?resolver=string&transaction_id=string&version=0&force_reload=falseAdds a new nameserver to the resolvers section.
  • GETReturn a nameserver/services/haproxy/configuration/nameservers/:name?resolver=string&transaction_id=stringReturns one nameserver configuration by it's name.
  • PUTReplace a nameserver/services/haproxy/configuration/nameservers/:name?resolver=string&transaction_id=string&version=0&force_reload=falseReplaces a nameserver configuration by it's name.
  • DELETEDelete a nameserver/services/haproxy/configuration/nameservers/:name?resolver=string&transaction_id=string&version=0&force_reload=falseDeletes a nameserver from the resolvers section by it's name.

Peer

  • GETReturn an array of peer_section/services/haproxy/configuration/peer_section?transaction_id=stringReturns an array of all configured peer_section.
  • POSTAdd a peer/services/haproxy/configuration/peer_section?transaction_id=string&version=0&force_reload=falseAdds a new peer to the configuration file.
  • GETReturn a peer/services/haproxy/configuration/peer_section/:name?transaction_id=stringReturns one peer configuration by it's name.
  • DELETEDelete a peer/services/haproxy/configuration/peer_section/:name?transaction_id=string&version=0&force_reload=falseDeletes a peer from the configuration by it's name.

PeerEntry

  • GETReturn an array of peer_entries/services/haproxy/configuration/peer_entries?peer_section=string&transaction_id=stringReturns an array of all peer_entries that are configured in specified peer section.
  • POSTAdd a new peer_entry/services/haproxy/configuration/peer_entries?peer_section=string&transaction_id=string&version=0&force_reload=falseAdds a new peer entry in the specified peer section in the configuration file.
  • GETReturn one peer_entry/services/haproxy/configuration/peer_entries/:name?peer_section=string&transaction_id=stringReturns one peer_entry configuration by it's name in the specified peer section.
  • PUTReplace a peer_entry/services/haproxy/configuration/peer_entries/:name?peer_section=string&transaction_id=string&version=0&force_reload=falseReplaces a peer entry configuration by it's name in the specified peer section.
  • DELETEDelete a peer_entry/services/haproxy/configuration/peer_entries/:name?peer_section=string&transaction_id=string&version=0&force_reload=falseDeletes a peer entry configuration by it's name in the specified peer section.

Cluster

  • POSTPost cluster settings/cluster?configuration=keep&version=0Post cluster settings
  • POSTInitiates a certificate refresh/cluster/certificateInitiates a certificate refresh

Maps

  • GETReturn runtime map files/services/haproxy/runtime/maps?include_unmanaged=falseReturns runtime map files.
  • GETReturn one runtime map file/services/haproxy/runtime/maps/:nameReturns one runtime map file.
  • DELETERemove all map entries from the map file/services/haproxy/runtime/maps/:name?forceDelete=true&force_sync=falseRemove all map entries from the map file.
  • GETReturn one map runtime entries/services/haproxy/runtime/maps_entries?map=stringReturns an array of all entries in a given runtime map file.
  • POSTAdds an entry into the map file/services/haproxy/runtime/maps_entries?map=string&force_sync=falseAdds an entry into the map file.
  • GETReturn one map runtime setting/services/haproxy/runtime/maps_entries/:id?map=stringReturns one map runtime setting by it's id.
  • PUTReplace the value corresponding to each id in a map/services/haproxy/runtime/maps_entries/:id?map=string&force_sync=falseReplaces the value corresponding to each id in a map.
  • DELETEDeletes all the map entries from the map by its id/services/haproxy/runtime/maps_entries/:id?map=string&force_sync=falseDelete all the map entries from the map by its id.

SpecificationOpenapiv3

  • GETData Plane API v3 Specification/specification_openapiv3Return Data Plane API OpenAPI v3 specification

ServiceDiscovery

  • GETReturn an array of all configured Consul servers/service_discovery/consulReturns all configured Consul servers.
  • POSTAdd a new Consul server/service_discovery/consulAdds a new Consul server.
  • GETReturn one Consul server/service_discovery/consul/:idReturns one Consul server configuration by it's id.
  • PUTReplace a Consul server/service_discovery/consul/:idReplaces a Consul server configuration by it's id.
  • DELETEDelete a Consul server/service_discovery/consul/:idDeletes a Consul server configuration by it's id.

Spoe

  • GETReturn all available SPOE files/services/haproxy/spoe/spoe_filesReturns all available SPOE files.
  • POSTCreates SPOE file with its entries/services/haproxy/spoe/spoe_filesCreates SPOE file with its entries.
  • GETReturn one SPOE file/services/haproxy/spoe/spoe_files/:nameReturns one SPOE file.
  • DELETEDelete SPOE file/services/haproxy/spoe/spoe_files/:nameDeletes SPOE file.
  • GETReturn an array of spoe scopes/services/haproxy/spoe/spoe_scopes?spoe=string&transaction_id=stringReturns an array of all configured spoe scopes.
  • POSTAdd a new spoe scope/services/haproxy/spoe/spoe_scopes?spoe=string&transaction_id=string&version=0Adds a new spoe scope.
  • GETReturn one SPOE scope/services/haproxy/spoe/spoe_scopes/:name?spoe=string&transaction_id=stringReturns one SPOE scope in one SPOE file.
  • DELETEDelete a SPOE scope/services/haproxy/spoe/spoe_scopes/:name?spoe=string&transaction_id=string&version=0Deletes a SPOE scope from the configuration file.
  • GETReturn an array of spoe agents in one scope/services/haproxy/spoe/spoe_agents?spoe=string&scope=string&transaction_id=stringReturns an array of all configured spoe agents in one scope.
  • POSTAdd a new spoe agent to scope/services/haproxy/spoe/spoe_agents?spoe=string&scope=string&transaction_id=string&version=0Adds a new spoe agent to the spoe scope.
  • GETReturn a spoe agent/services/haproxy/spoe/spoe_agents/:name?spoe=string&scope=string&transaction_id=stringReturns one spoe agent configuration in one SPOE scope.
  • PUTReplace a SPOE agent/services/haproxy/spoe/spoe_agents/:name?spoe=string&scope=string&transaction_id=string&version=0Replaces a SPOE agent configuration in one SPOE scope.
  • DELETEDelete a SPOE agent/services/haproxy/spoe/spoe_agents/:name?spoe=string&scope=string&transaction_id=string&version=0Deletes a SPOE agent from the configuration in one SPOE scope.
  • GETReturn an array of spoe messages in one scope/services/haproxy/spoe/spoe_messages?spoe=string&scope=string&transaction_id=stringReturns an array of all configured spoe messages in one scope.
  • POSTAdd a new spoe message to scope/services/haproxy/spoe/spoe_messages?spoe=string&scope=string&transaction_id=string&version=0Adds a new spoe message to the spoe scope.
  • GETReturn a spoe message/services/haproxy/spoe/spoe_messages/:name?spoe=string&scope=string&transaction_id=stringReturns one spoe message configuration in SPOE scope.
  • PUTReplace a spoe message/services/haproxy/spoe/spoe_messages/:name?spoe=string&scope=string&transaction_id=string&version=0Replaces a spoe message configuration in one SPOE scope.
  • DELETEDelete a spoe message/services/haproxy/spoe/spoe_messages/:name?spoe=string&scope=string&transaction_id=string&version=0Deletes a spoe message from the SPOE scope.
  • GETReturn an array of SPOE groups/services/haproxy/spoe/spoe_groups?spoe=string&scope=string&transaction_id=stringReturns an array of all configured SPOE groups in one SPOE scope.
  • POSTAdd a new SPOE groups/services/haproxy/spoe/spoe_groups?spoe=string&scope=string&transaction_id=string&version=0Adds a new SPOE groups to the SPOE scope.
  • GETReturn a SPOE groups/services/haproxy/spoe/spoe_groups/:name?spoe=string&scope=string&transaction_id=stringReturns one SPOE groups configuration in one SPOE scope.
  • PUTReplace a SPOE groups/services/haproxy/spoe/spoe_groups/:name?spoe=string&scope=string&transaction_id=string&version=0Replaces a SPOE groups configuration in one SPOE scope.
  • DELETEDelete a SPOE groups/services/haproxy/spoe/spoe_groups/:name?spoe=string&scope=string&transaction_id=string&version=0Deletes a SPOE groups from the one SPOE scope.
  • GETReturn a SPOE configuration version/services/haproxy/spoe/version?transaction_id=string&spoe=stringReturns SPOE configuration version.

SpoeTransactions

  • GETReturn list of SPOE configuration transactions./services/haproxy/spoe_transactions?spoe=string&status=failedReturns a list of SPOE configuration transactions. Transactions can be filtered by their status.
  • POSTStart a new transaction/services/haproxy/spoe_transactions?spoe=string&version=0Starts a new transaction and returns it's id
  • GETReturn one SPOE configuration transactions/services/haproxy/spoe_transactions/:id?spoe=stringReturns one SPOE configuration transactions.
  • PUTCommit transaction/services/haproxy/spoe_transactions/:id?spoe=string&force_reload=falseCommit transaction, execute all operations in transaction and return msg
  • DELETEDelete a transaction/services/haproxy/spoe_transactions/:id?spoe=stringDeletes a transaction.

Storage

  • GETReturn a list of all managed map files/services/haproxy/storage/mapsReturns a list of all managed map files
  • POSTCreates a managed runtime map file with its entries/services/haproxy/storage/mapsCreates a managed runtime map file with its entries.
  • GETReturn the contents of one managed map file from disk/services/haproxy/storage/maps/:nameReturns the contents of one managed map file from disk
  • PUTReplace contents of a managed map file on disk/services/haproxy/storage/maps/:name?force_reload=falseReplaces the contents of a managed map file on disk
  • DELETEDeletes a managed map file from disk/services/haproxy/storage/maps/:nameDeletes a managed map file from disk.
  • GETReturn all available SSL certificates on disk/services/haproxy/storage/ssl_certificatesReturns all available SSL certificates on disk.
  • POSTCreate SSL certificate/services/haproxy/storage/ssl_certificates?force_reload=falseCreates SSL certificate.
  • GETReturn one SSL certificate from disk/services/haproxy/storage/ssl_certificates/:nameReturns one SSL certificate from disk.
  • PUTReplace SSL certificates on disk/services/haproxy/storage/ssl_certificates/:name?force_reload=falseReplaces SSL certificate on disk.
  • DELETEDelete SSL certificate from disk/services/haproxy/storage/ssl_certificates/:nameDeletes SSL certificate from disk.

API details

Authentication
HTTP Basic authentication (username and password)
Operations
180 operations on 87 pathsGET 86POST 33DELETE 31PUT 30
Main resources
Spoe 24Storage 10Maps 8Server 8Discovery 7ACL 5Backend 5BackendSwitchingRule 5Bind 5Filter 5
Response formats
application/json
Description format
Swagger 2.0, API version 2.0

How to test the HAProxy Data Plane API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the HAProxy Data Plane API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Return list of root endpoints” (GET /), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the HAProxy Data Plane API?

API for editing and managing haproxy instances. Provides process information, configuration management, haproxy stats and logs. It is listed under Developer tools and has 180 endpoints.

Who publishes the HAProxy Data Plane API?

It is listed from HAProxy Data Plane API's public API description (an OpenAPI document), not published by HAProxy Data Plane API on Swastik Codes. Anyone who controls haproxy.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the HAProxy Data Plane API?

With HTTP Basic authentication (username and password).

How many endpoints does the HAProxy Data Plane API have?

180 operations on 87 paths (86 GET, 33 POST, 31 DELETE, 30 PUT). The largest groups are Spoe, Storage, Maps, Server.

Is forking the HAProxy Data Plane API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.