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

The Peer API from HAProxy — 2 operation(s) for peer.

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

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

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

4 operations 2 paths 14 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 4

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

Peer 4
GET
/services/haproxy/configuration/peer_section
Return an array of peersection
getPeerSections 2 params → 200default
POST
/services/haproxy/configuration/peer_section
Add a peer
createPeer 4 params body → 201202400409default
DELETE
/services/haproxy/configuration/peer_section/{name}
Delete a peer
deletePeer 4 params → 202204404default
GET
/services/haproxy/configuration/peer_section/{name}
Return a peer
getPeerSection 3 params → 200404default

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are server_params (111 properties), bind_params (87 properties), log_target (12 properties), table (10 properties). Each schema is shown below with its type and property counts.

bind_params
object
87 properties
log_target
object
Per-instance logging of events and traffic.
12 properties
log_targets
array
HAProxy log target array (corresponds to log directives)
table
object
10 properties 1 required
error
object
API Error
2 properties 2 required
server_params
object
111 properties
bind
HAProxy frontend bind configuration
peer_entry
object
Peer Entry from peers table
5 properties 3 required
server
HAProxy backend server configuration
peer_section_base
object
HAProxy peersection configuration
7 properties 1 required
default_server
peer_section
object
Peer Section with all its children resources
default_bind
HAProxy default bind configuration
peer_sections
array
HAProxy peersection array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

haproxy-peer-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 Peer 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.