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 Access mTLS Authentication API

The Access mTLS Authentication API from APIs.io Engineering Platform — 3 operation(s) for access mtls authentication.

This API exposes 7 operations across 3 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.

7 operations 3 paths 18 schemas 1 DELETE3 GET1 POST2 PUT

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 Access mTLS Authentication 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 7

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

Access mTLS Authentication 7
GET
/accounts/{account_id}/access/certificates
APIs.io Engineering Platform List mTLS certificates
access-mtls-authentication-list-mtls-certificates 1 param → 4XX200
POST
/accounts/{account_id}/access/certificates
APIs.io Engineering Platform Add an mTLS certificate
access-mtls-authentication-add-an-mtls-certificate 1 param body → 4XX201
DELETE
/accounts/{account_id}/access/certificates/{certificate_id}
APIs.io Engineering Platform Delete an mTLS certificate
access-mtls-authentication-delete-an-mtls-certificate 2 params → 4XX200
GET
/accounts/{account_id}/access/certificates/{certificate_id}
APIs.io Engineering Platform Get an mTLS certificate
access-mtls-authentication-get-an-mtls-certificate 2 params → 4XX200
PUT
/accounts/{account_id}/access/certificates/{certificate_id}
APIs.io Engineering Platform Update an mTLS certificate
access-mtls-authentication-update-an-mtls-certificate 2 params body → 4XX200
GET
/accounts/{account_id}/access/certificates/settings
APIs.io Engineering Platform List all mTLS hostname settings
access-mtls-authentication-list-mtls-certificates-hostname-settings 1 param → 4XX200
PUT
/accounts/{account_id}/access/certificates/settings
APIs.io Engineering Platform Update an mTLS certificate's hostname settings
access-mtls-authentication-update-an-mtls-certificate-settings 1 param body → 4XX202

Schemas 18

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

access_settings
object
3 properties 3 required
access_api-response-common
object
3 properties 3 required
access_result_info
object
4 properties
access_api-response-common-failure
object
4 properties 4 required
access_messages
array
access_response_collection_hostnames
access_fingerprint
string
The MD5 fingerprint of the certificate.
access_api-response-collection
object
access_certificates_components-schemas-single_response
access_components-schemas-id_response
access_certificates
object
7 properties
access_certificates_components-schemas-response_collection
access_uuid
string
UUID
access_certificates_components-schemas-name
string
The name of the certificate.
access_associated_hostnames
array
The hostnames of the applications that will use this certificate.
access_timestamp
string
access_api-response-single
object
access_identifier
string
Identifier

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-access-mtls-authentication-api-openapi.yml Raw ↑