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 mTLS Certificate Management API

The mTLS Certificate Management API from APIs.io Engineering Platform — 3 operation(s) for mtls certificate management.

This API exposes 5 operations across 3 paths, and defines 26 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.

5 operations 3 paths 26 schemas 1 DELETE3 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 mTLS Certificate Management 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 5

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

mTLS Certificate Management 5
GET
/accounts/{account_id}/mtls_certificates
APIs.io Engineering Platform List mTLS certificates
m-tls-certificate-management-list-m-tls-certificates 1 param → 4XX200
POST
/accounts/{account_id}/mtls_certificates
APIs.io Engineering Platform Upload mTLS certificate
m-tls-certificate-management-upload-m-tls-certificate 1 param body → 4XX200
DELETE
/accounts/{account_id}/mtls_certificates/{mtls_certificate_id}
APIs.io Engineering Platform Delete mTLS certificate
m-tls-certificate-management-delete-m-tls-certificate 2 params body → 4XX200
GET
/accounts/{account_id}/mtls_certificates/{mtls_certificate_id}
APIs.io Engineering Platform Get mTLS certificate
m-tls-certificate-management-get-m-tls-certificate 2 params → 4XX200
GET
/accounts/{account_id}/mtls_certificates/{mtls_certificate_id}/associations
APIs.io Engineering Platform List mTLS certificate associations
m-tls-certificate-management-list-m-tls-certificate-associations 2 params → 4XX200

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are tls-certificates-and-hostnames_certificateObjectPost (10 properties), tls-certificates-and-hostnames_components-schemas-certificateObject (9 properties), tls-certificates-and-hostnames_api-response-common-failure (4 properties), tls-certificates-and-hostnames_result_info (4 properties). Each schema is shown below with its type and property counts.

tls-certificates-and-hostnames_components-schemas-private_key
string
The private key for the certificate
tls-certificates-and-hostnames_ca
boolean
Indicates whether the certificate is a CA or leaf certificate.
tls-certificates-and-hostnames_certificate_response_single_post
tls-certificates-and-hostnames_identifier
string
Identifier
tls-certificates-and-hostnames_schemas-issuer
string
The certificate authority that issued the certificate.
tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_single
tls-certificates-and-hostnames_result_info
object
4 properties
tls-certificates-and-hostnames_association_response_collection
tls-certificates-and-hostnames_mtls-management_components-schemas-uploaded_on
string
This is the time the certificate was uploaded.
tls-certificates-and-hostnames_api-response-common
object
3 properties 3 required
tls-certificates-and-hostnames_components-schemas-certificateObject
object
9 properties
tls-certificates-and-hostnames_mtls-management_components-schemas-expires_on
string
When the certificate expires.
tls-certificates-and-hostnames_signature
string
The type of hash used for the certificate.
tls-certificates-and-hostnames_associationObject
object
2 properties
tls-certificates-and-hostnames_messages
array
tls-certificates-and-hostnames_schemas-name
string
Optional unique name for the certificate. Only used for human readability.
tls-certificates-and-hostnames_mtls-management_components-schemas-status
string
Certificate deployment status for the given service.
tls-certificates-and-hostnames_schemas-serial_number
string
The certificate serial number.
tls-certificates-and-hostnames_service
string
The service using the certificate.
tls-certificates-and-hostnames_mtls-management_components-schemas-certificate_response_collection
tls-certificates-and-hostnames_components-schemas-updated_at
string
This is the time the certificate was updated.
tls-certificates-and-hostnames_schemas-certificates
string
The uploaded root CA certificate.
tls-certificates-and-hostnames_certificateObjectPost
object
10 properties
tls-certificates-and-hostnames_api-response-single
object
tls-certificates-and-hostnames_api-response-collection
object
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-mtls-certificate-management-api-openapi.yml Raw ↑