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

APIs.io Engineering Platform Origin CA API

The Origin CA API from APIs.io Engineering Platform — 2 operation(s) for origin ca.

This API exposes 4 operations across 2 paths, and defines 18 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

4 operations 2 paths 18 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Origin CA API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 4

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

Origin CA 4
GET
/certificates
APIs.io Engineering Platform List Certificates
origin-ca-list-certificates 1 param → 4XX200
POST
/certificates
APIs.io Engineering Platform Create Certificate
origin-ca-create-certificate body → 4XX200
DELETE
/certificates/{certificate_id}
APIs.io Engineering Platform Revoke Certificate
origin-ca-revoke-certificate 1 param body → 4XX200
GET
/certificates/{certificate_id}
APIs.io Engineering Platform Get Certificate
origin-ca-get-certificate 1 param → 4XX200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are tls-certificates-and-hostnames_certificates (7 properties), tls-certificates-and-hostnames_result_info (4 properties), tls-certificates-and-hostnames_api-response-common-failure (4 properties), tls-certificates-and-hostnames_api-response-common (3 properties). Each schema is shown below with its type and property counts.

tls-certificates-and-hostnames_revoked_at
string
When the certificate was revoked.
tls-certificates-and-hostnames_request_type
string
Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).
tls-certificates-and-hostnames_schemas-certificate_response_single
tls-certificates-and-hostnames_certificate_revoke_response
tls-certificates-and-hostnames_certificates
object
7 properties 4 required
tls-certificates-and-hostnames_requested_validity
number
The number of days for which the certificate should be valid.
tls-certificates-and-hostnames_api-response-single
object
tls-certificates-and-hostnames_hostnames
array
Array of hostnames or wildcard names (e.g., .example.com) bound to the certificate.
tls-certificates-and-hostnames_api-response-collection
object
tls-certificates-and-hostnames_messages
array
tls-certificates-and-hostnames_identifier
string
Identifier
tls-certificates-and-hostnames_csr
string
The Certificate Signing Request (CSR). Must be newline-encoded.
tls-certificates-and-hostnames_components-schemas-certificate
string
The Origin CA certificate. Will be newline-encoded.
tls-certificates-and-hostnames_result_info
object
4 properties
tls-certificates-and-hostnames_schemas-certificate_response_collection
tls-certificates-and-hostnames_api-response-common
object
3 properties 3 required
tls-certificates-and-hostnames_schemas-expires_on
string
When the certificate will expire.
tls-certificates-and-hostnames_api-response-common-failure
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-origin-ca-api-openapi.yml Raw ↑