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

The Spoe API from HAProxy — 11 operation(s) for spoe.

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

Tagged areas include Spoe. 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 24 operations across 11 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.

24 operations 11 paths 14 schemas 5 DELETE11 GET5 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 24

Across 11 paths, the API surfaces 24 operations — 5 DELETE, 11 GET, 5 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Spoe 24
GET
/services/haproxy/spoe/spoe_files
Return all available SPOE files
getAllSpoeFiles → 200404default
POST
/services/haproxy/spoe/spoe_files
Creates SPOE file with its entries
createSpoe body → 201400409default
DELETE
/services/haproxy/spoe/spoe_files/{name}
Delete SPOE file
deleteSpoeFile 1 param → 204404default
GET
/services/haproxy/spoe/spoe_files/{name}
Return one SPOE file
getOneSpoeFile 1 param → 200404default
GET
/services/haproxy/spoe/spoe_files/{parent_name}/scopes
Return an array of spoe scopes
getAllSpoeScope 2 params → 200default
POST
/services/haproxy/spoe/spoe_files/{parent_name}/scopes
Add a new spoe scope
createSpoeScope 3 params body → 201400409default
DELETE
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{name}
Delete a SPOE scope
deleteSpoeScope 4 params → 204404default
GET
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{name}
Return one SPOE scope
getSpoeScope 3 params → 200404default
GET
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/agents
Return an array of spoe agents in one scope
getAllSpoeAgent 3 params → 200default
POST
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/agents
Add a new spoe agent to scope
createSpoeAgent 4 params body → 201400409default
DELETE
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/agents/{name}
Delete a SPOE agent
deleteSpoeAgent 5 params → 204404default
GET
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/agents/{name}
Return a spoe agent
getSpoeAgent 4 params → 200404default
PUT
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/agents/{name}
Replace a SPOE agent
replaceSpoeAgent 5 params body → 200400404default
GET
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/messages
Return an array of spoe messages in one scope
getAllSpoeMessage 3 params → 200default
POST
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/messages
Add a new spoe message to scope
createSpoeMessage 4 params body → 201400409default
DELETE
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/messages/{name}
Delete a spoe message
deleteSpoeMessage 5 params → 204404default
GET
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/messages/{name}
Return a spoe message
getSpoeMessage 4 params → 200404default
PUT
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/messages/{name}
Replace a spoe message
replaceSpoeMessage 5 params body → 200400404default
GET
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/groups
Return an array of SPOE groups
getAllSpoeGroup 3 params → 200default
POST
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/groups
Add a new SPOE groups
createSpoeGroup 4 params body → 201400409default
DELETE
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/groups/{name}
Delete a SPOE groups
deleteSpoeGroup 5 params → 204404default
GET
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/groups/{name}
Return a SPOE groups
getSpoeGroup 4 params → 200404default
PUT
/services/haproxy/spoe/spoe_files/{parent_name}/scopes/{scope_name}/groups/{name}
Replace a SPOE groups
replaceSpoeGroup 5 params body → 200400404default
GET
/services/haproxy/spoe/{parent_name}/version
Return a SPOE configuration version
getSpoeConfigurationVersion 2 params → 200404default

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are spoe_agent (24 properties), log_target (12 properties), spoe_message (4 properties), acl (4 properties). Each schema is shown below with its type and property counts.

spoe_scope
string
SPOE scope name
acls
array
HAProxy ACL lines array (corresponds to acl 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
spoe_agents
array
SPOE Agents of one scope in SPOE file
spoe_group
object
SPOE group section configuration
2 properties 1 required
log_target
object
Per-instance logging of events and traffic.
12 properties
log_targets
array
HAProxy log target array (corresponds to log directives)
error
object
API Error
2 properties 2 required
spoe_scopes
array
All SPOE Scopes
spoe_agent
object
SPOE agent configuration
24 properties 1 required
spoe_message
object
SPOE message section configuration
4 properties 1 required
spoe_messages
array
SPOE Messages of one scope in SPOE file
spoe_groups
array
SPOE Groups of one scope in SPOE file
spoe_files
array
SPOE files

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

haproxy-spoe-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 Spoe 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.