Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HorizonIQ SSL Certificates API

The SSL Certificates API from HorizonIQ — 5 operation(s) for ssl certificates.

HorizonIQ SSL Certificates API is one of 9 APIs that HorizonIQ publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SSL Certificates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 5 operations across 5 paths, and defines 7 schemas. It is described by OpenAPI 3.0.1, at version 2023-05-30T22:28:43Z.

Requests are made against a single base URL, https://api.compass.horizoniq.com/{basePath}.

5 operations 5 paths 7 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2023-05-30T22:28:43Z
Base URL
https://api.compass.horizoniq.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

HorizonIQ SSL Certificates API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — API token issued from the Compass portal (Profile API Tokens). Sent as Authorization: Bearer . See https://compass-horizoniq.readme.io/reference/authentication

Paths & Operations 5

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

SSL Certificates 5
GET
/ssl-certificates/{certificateId}
Get SSL Certificate
getSslCertificatesByCertificateId 2 params → 200404
GET
/ssl-certificates
List SSL Certificates
getSslCertificates 6 params → 200
POST
/ssl-certificates/{certificateId}/finalize
Finalize SSL Certificate
createSslCertificatesByCertificateIdFinalize 2 params body → 200404
POST
/ssl-certificates/{certificateId}/resend-approval
SSL Certificate approval
createSslCertificatesByCertificateIdResendApproval 2 params → 200404
POST
/ssl-certificates/initialize
Initialize SSL Certificate
createSslCertificatesInitialize 1 param body → 200404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are CertificateGetModel (16 properties), CertificateListModel (8 properties), CertificateInitializePostModel (5 properties), CertificateInitializeResponseModel (3 properties). Each schema is shown below with its type and property counts.

CertificateInitializeResponseModel
object
3 properties
CertificateListModel
object
8 properties
CertificateFinalizePostModel
object
2 properties 2 required
SuccessStringModel
object
1 property
ErrorModel
object
1 property
CertificateInitializePostModel
object
5 properties 5 required
CertificateGetModel
object
16 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

horizoniq-ssl-certificates-api-openapi.yml Raw ↑

Other APIs HorizonIQ publishes across the network.

HorizonIQ Action Items API
HorizonIQ Billing API
HorizonIQ Devices API
HorizonIQ Images API
HorizonIQ Managed Firewalls API
HorizonIQ Servers API
HorizonIQ Support API
HorizonIQ User Accounts API