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

The Storage API from HAProxy — 9 operation(s) for storage.

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

Tagged areas include Storage. 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 23 operations across 9 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 3.4.

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

23 operations 9 paths 11 schemas 5 DELETE9 GET5 POST4 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 Storage API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basic_auth). By default, every request must be authenticated.

Paths & Operations 23

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

Storage 23
GET
/services/haproxy/storage/maps
Return a list of all managed map files
getAllStorageMapFiles → 200404default
POST
/services/haproxy/storage/maps
Creates a managed storage map file with its entries
createStorageMapFile body → 201400409default
DELETE
/services/haproxy/storage/maps/{name}
Deletes a managed map file from disk
deleteStorageMap 1 param → 204404default
GET
/services/haproxy/storage/maps/{name}
Return the contents of one managed map file from disk
getOneStorageMap 1 param → 200404default
PUT
/services/haproxy/storage/maps/{name}
Replace contents of a managed map file on disk
replaceStorageMapFile 3 params body → 202204400404default
GET
/services/haproxy/storage/ssl_certificates
Return all available SSL certificates on disk
getAllStorageSSLCertificates → 200404default
POST
/services/haproxy/storage/ssl_certificates
Create SSL certificate
createStorageSSLCertificate 2 params body → 201202400409default
DELETE
/services/haproxy/storage/ssl_certificates/{name}
Delete SSL certificate from disk
deleteStorageSSLCertificate 3 params → 202204404default
GET
/services/haproxy/storage/ssl_certificates/{name}
Return one SSL certificate from disk
getOneStorageSSLCertificate 1 param → 200404default
PUT
/services/haproxy/storage/ssl_certificates/{name}
Replace SSL certificates on disk
replaceStorageSSLCertificate 3 params body → 200202400404default
GET
/services/haproxy/storage/ssl_crt_lists
Return all available certificate lists on disk
getAllStorageSSLCrtListFiles → 200404default
POST
/services/haproxy/storage/ssl_crt_lists
Create a certificate list
createStorageSSLCrtListFile 1 param body → 201202400409default
DELETE
/services/haproxy/storage/ssl_crt_lists/{name}
Delete a certificate list from disk
deleteStorageSSLCrtListFile 3 params → 202204404default
GET
/services/haproxy/storage/ssl_crt_lists/{name}
Return one certificate list from disk
getOneStorageSSLCrtListFile 1 param → 200404default
PUT
/services/haproxy/storage/ssl_crt_lists/{name}
Replace a certificate lists on disk
replaceStorageSSLCrtListFile 3 params body → 200202400404default
DELETE
/services/haproxy/storage/ssl_crt_lists/{name}/entries
Deletes an entry from CrtList file
DeleteStorageSSLCrtListEntry 4 params → 202204400404default
GET
/services/haproxy/storage/ssl_crt_lists/{name}/entries
Returns all the entries in a CrtList
GetStorageSSLCrtListEntries 1 param → 200404default
POST
/services/haproxy/storage/ssl_crt_lists/{name}/entries
Creates a new entry in a CrtList
CreateStorageSSLCrtListEntry 2 params body → 201202400409default
GET
/services/haproxy/storage/general
Return a list of all managed general use files
getAllStorageGeneralFiles → 200404default
POST
/services/haproxy/storage/general
Creates a managed storage general use file with contents
createStorageGeneralFile body → 201400409default
DELETE
/services/haproxy/storage/general/{name}
Deletes a managed general use file from disk
deleteStorageGeneralFile 1 param → 204404default
GET
/services/haproxy/storage/general/{name}
Return the contents of one managed general use file from disk
getOneStorageGeneralFile 1 param → 200404default
PUT
/services/haproxy/storage/general/{name}
Replace contents of a managed general use file on disk
replaceStorageGeneralFile 3 params body → 202204400404default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ssl_certificate (20 properties), general_file (5 properties), map (5 properties), ssl_crt_list_file (4 properties). Each schema is shown below with its type and property counts.

ssl_crt_list_entries
array
Array of SSL Crt List Entry
ssl_certificate
object
A file containing one or more SSL/TLS certificates and keys
20 properties
general_file
object
General use file
5 properties
map
object
Map File
5 properties
ssl_crt_list_files
array
List of SSL certificate list files (crt-list)
ssl_crt_list_file
object
A file referencing one or more certificates with their configuration.
4 properties
ssl_crt_list_entry
object
SSL Crt List Entry
4 properties
ssl_certificates
array
Array of ssl certificate files
general_files
array
Array of general use files
maps
array
Array of runtime map files
error
object
API Error
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

haproxy-storage-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 Storage 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.