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

The Zone-Level Access mTLS Authentication API from APIs.io Engineering Platform — 1 operation(s) for zone-level access mtls authentication.

This API exposes 1 operation across 1 path, and defines 12 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.

1 operations 1 paths 12 schemas 1 GET

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 Zone-Level 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Zone-Level Access mTLS Authentication 1
GET
/zones/{zone_id}/access/certificates
APIs.io Engineering Platform List mTLS certificates
zone-level-access-mtls-authentication-list-mtls-certificates 1 param → 4XX200

Schemas 12

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

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_fingerprint
string
The MD5 fingerprint of the certificate.
access_api-response-collection
object
access_schemas-certificates
object
7 properties
access_certificates_components-schemas-response_collection-2
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_identifier
string
Identifier

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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