How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HAProxy Service Discovery API

The Service Discovery API from HAProxy — 4 operation(s) for service discovery.

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

Tagged areas include Service Discovery. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, a GitHub repository, and a changelog.

This API exposes 10 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 3.4.

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

10 operations 4 paths 6 schemas 2 DELETE4 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.4
Base URL
http://{haproxy-host}:5555/v3/services/haproxy/runtime
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

HAProxy Service Discovery API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basic_auth). By default, every request must be authenticated.

Paths & Operations 10

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

Service Discovery 10
GET
/service_discovery/aws
Return an array of all configured AWS regions
getAWSRegions → 200default
POST
/service_discovery/aws
Add a new AWS region
createAWSRegion body → 201400409default
DELETE
/service_discovery/aws/{id}
Delete an AWS region
deleteAWSRegion 1 param → 204404default
GET
/service_discovery/aws/{id}
Return an AWS region
getAWSRegion 1 param → 200404default
PUT
/service_discovery/aws/{id}
Replace an AWS region
replaceAWSRegion 1 param body → 200400404default
GET
/service_discovery/consul
Return an array of all configured Consul servers
getConsuls → 200default
POST
/service_discovery/consul
Add a new Consul server
createConsul body → 201400409default
DELETE
/service_discovery/consul/{id}
Delete a Consul server
deleteConsul 1 param → 204404default
GET
/service_discovery/consul/{id}
Return one Consul server
getConsul 1 param → 200404default
PUT
/service_discovery/consul/{id}
Replace a Consul server
replaceConsul 1 param body → 200400404default

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are consul (19 properties), awsRegion (14 properties), error (2 properties), awsFilters (2 properties). Each schema is shown below with its type and property counts.

awsFilters
object
2 properties 2 required
consul
object
Consul server configuration
19 properties 4 required
awsRegions
array
AWS regions array
awsRegion
object
AWS region configuration
14 properties 5 required
error
object
API Error
2 properties 2 required
consuls
array
Consuls array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

haproxy-service-discovery-api-openapi.yml Raw ↑

Other APIs HAProxy publishes across the network.

HAProxy Runtime API
HAProxy Kubernetes Ingress Controller
HAProxy ACL API
HAProxy ACL Runtime API
HAProxy Acme API
HAProxy Acme Runtime API
HAProxy Backend API
HAProxy Backend Switching Rule API
HAProxy Bind API
HAProxy Cache API
HAProxy Configuration API
HAProxy Crt Load API
Where this information came from

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