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 SSL Runtime API

The SSLRuntime API from HAProxy — 10 operation(s) for sslruntime.

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

Tagged areas include SSLRuntime. 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 21 operations across 10 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 3.4.

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

21 operations 10 paths 13 schemas 4 DELETE9 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 SSL Runtime API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basic_auth). By default, every request must be authenticated.

Paths & Operations 21

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

SSLRuntime 21
GET
/services/haproxy/runtime/ssl_ca_files
Return an array of all SSL CA files
getAllCaFiles → 200default
POST
/services/haproxy/runtime/ssl_ca_files
Creates a new SSL CA file
createCaFile body → 201400409default
DELETE
/services/haproxy/runtime/ssl_ca_files/{name}
Deletes a CA file
deleteCaFile 1 param → 204400default
GET
/services/haproxy/runtime/ssl_ca_files/{name}
Return an SSL CA file
getCaFile 1 param → 200404default
PUT
/services/haproxy/runtime/ssl_ca_files/{name}
Update the contents of a CA file
setCaFile 1 param body → 200400default
POST
/services/haproxy/runtime/ssl_ca_files/{name}/entries
Add a certificate to a CA file
addCaEntry 1 param body → 201404default
GET
/services/haproxy/runtime/ssl_ca_files/{name}/entries/{index}
Return an SSL CA file cert entry
getCaEntry 2 params → 200404default
GET
/services/haproxy/runtime/ssl_certs
Return a list of SSL certificate files
getAllCerts → 200default
POST
/services/haproxy/runtime/ssl_certs
Create a new SSL certificate file
createCert body → 201400409default
DELETE
/services/haproxy/runtime/ssl_certs/{name}
Delete a certificate
deleteCert 1 param → 204400default
GET
/services/haproxy/runtime/ssl_certs/{name}
Return one structured certificate
getCert 1 param → 200default
PUT
/services/haproxy/runtime/ssl_certs/{name}
Replace the contents of a certificate
replaceCert 1 param body → 200400default
GET
/services/haproxy/runtime/ssl_crl_files
Return an array of all the CRL files
getAllCrl → 200default
POST
/services/haproxy/runtime/ssl_crl_files
Create a new CRL file
createCrl body → 201400409default
DELETE
/services/haproxy/runtime/ssl_crl_files/{name}
Delete a CRL file
deleteCrl 1 param → 204400default
GET
/services/haproxy/runtime/ssl_crl_files/{name}
Get the contents of a CRL file
getCrl 2 params → 200404default
PUT
/services/haproxy/runtime/ssl_crl_files/{name}
Replace the contents of a CRL file
replaceCrl 1 param body → 200400default
GET
/services/haproxy/runtime/ssl_crt_lists
Get the list of all crt-list files
getAllCrtLists → 200default
DELETE
/services/haproxy/runtime/ssl_crt_lists/entries
Delete an entry from a crt-list
deleteCrtListEntry 3 params → 204400404default
GET
/services/haproxy/runtime/ssl_crt_lists/entries
Get all the entries inside a crt-list
getAllCrtListEntries 1 param → 200default
POST
/services/haproxy/runtime/ssl_crt_lists/entries
Add an entry into a crt-list
addCrtListEntry 1 param body → 201400409default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ssl_certificate (20 properties), ssl_crl_entry (8 properties), ssl_crt_list_entry (4 properties), ssl_ca_file (3 properties). Each schema is shown below with its type and property counts.

ssl_crt_list_entries
array
Array of SSL Crt List Entry
ssl_crl_entry
object
A certificate revocation list entry.
8 properties
ssl_certificate
object
A file containing one or more SSL/TLS certificates and keys
20 properties
ssl_crls
array
Array of ssl crl files
ssl_crl_entries
array
ssl_ca_file
object
A file containing one or more SSL/TLS certificates and keys
3 properties
ssl_crt_list_entry
object
SSL Crt List Entry
4 properties
ssl_certificates
array
Array of ssl certificate files
ssl_crt_lists
array
Array of SSL Crt List
ssl_crl
object
A file containing one or more SSL/TLS CRLs
3 properties
ssl_crt_list
object
SSL Crt List file
1 property
ssl_ca_files
array
Array of SSL CA files
error
object
API Error
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

haproxy-sslruntime-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 SSL Runtime 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.