# HAProxy Spoe API

**Canonical:** https://apis.io/apis/haproxy/haproxy-spoe-api/  
**Provider:** HAProxy — https://apis.io/providers/haproxy/  
**Base URL:** http://{haproxy-host}:5555/v3  
**Documentation:** https://www.haproxy.com/documentation/dataplaneapi/latest/

HAProxy Spoe API is one of 68 APIs that [HAProxy](https://apis.io/providers/haproxy/) publishes on the [APIs.io](https://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.

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

## Operations (24)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (8)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/haproxy/refs/heads/main/openapi/haproxy-spoe-api-openapi.yml
- **Documentation** — https://www.haproxy.com/documentation/haproxy-data-plane-api/
- **APIReference** — https://www.haproxy.com/documentation/haproxy-data-plane-api/reference/
- **GettingStarted** — https://www.haproxy.com/documentation/haproxy-data-plane-api/installation/
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/haproxy/refs/heads/main/data-model/haproxy-data-model.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/haproxy/refs/heads/main/errors/haproxy-problem-types.yml
- **GitHubRepository** — https://github.com/haproxytech/dataplaneapi
- **ChangeLog** — https://github.com/haproxytech/dataplaneapi/releases

## Other HAProxy APIs (12)

- [HAProxy Runtime API](https://apis.io/apis/haproxy/haproxy-runtime-api/)
- [HAProxy Kubernetes Ingress Controller](https://apis.io/apis/haproxy/haproxy-kubernetes-ingress-controller/)
- [HAProxy ACL API](https://apis.io/apis/haproxy/haproxy-acl-api/)
- [HAProxy ACL Runtime API](https://apis.io/apis/haproxy/haproxy-acl-runtime-api/)
- [HAProxy Acme API](https://apis.io/apis/haproxy/haproxy-acme-api/)
- [HAProxy Acme Runtime API](https://apis.io/apis/haproxy/haproxy-acmeruntime-api/)
- [HAProxy Backend API](https://apis.io/apis/haproxy/haproxy-backend-api/)
- [HAProxy Backend Switching Rule API](https://apis.io/apis/haproxy/haproxy-backendswitchingrule-api/)
- [HAProxy Bind API](https://apis.io/apis/haproxy/haproxy-bind-api/)
- [HAProxy Cache API](https://apis.io/apis/haproxy/haproxy-cache-api/)
- [HAProxy Configuration API](https://apis.io/apis/haproxy/haproxy-configuration-api/)
- [HAProxy Crt Load API](https://apis.io/apis/haproxy/haproxy-crtload-api/)

## Tags

Spoe

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/haproxy/haproxy-spoe-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/haproxy/.