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 Zero Trust Certificates API

The Zero Trust Certificates API from APIs.io Engineering Platform — 4 operation(s) for zero trust certificates.

This API exposes 6 operations across 4 paths, and defines 15 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.

6 operations 4 paths 15 schemas 1 DELETE2 GET3 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 Zero Trust Certificates 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 6

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

Zero Trust Certificates 6
GET
/accounts/{account_id}/gateway/certificates
APIs.io Engineering Platform List Zero Trust certificates
zero-trust-certificates-list-zero-trust-certificates 1 param → 4XX200
POST
/accounts/{account_id}/gateway/certificates
APIs.io Engineering Platform Create Zero Trust certificate
zero-trust-certificates-create-zero-trust-certificate 1 param body → 4XX200
DELETE
/accounts/{account_id}/gateway/certificates/{certificate_id}
APIs.io Engineering Platform Delete Zero Trust certificate
zero-trust-certificates-delete-zero-trust-certificate 2 params body → 4XX200
GET
/accounts/{account_id}/gateway/certificates/{certificate_id}
APIs.io Engineering Platform Get Zero Trust certificate details
zero-trust-certificates-zero-trust-certificate-details 2 params → 4XX200
POST
/accounts/{account_id}/gateway/certificates/{certificate_id}/activate
APIs.io Engineering Platform Activate a Zero Trust certificate
zero-trust-certificates-activate-zero-trust-certificate 2 params body → 4XX202
POST
/accounts/{account_id}/gateway/certificates/{certificate_id}/deactivate
APIs.io Engineering Platform Deactivate a Zero Trust certificate
zero-trust-certificates-deactivate-zero-trust-certificate 2 params body → 4XX201

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are zero-trust-gateway_certificates (12 properties), zero-trust-gateway_result_info (4 properties), zero-trust-gateway_api-response-common-failure (4 properties), zero-trust-gateway_api-response-common (3 properties). Each schema is shown below with its type and property counts.

zero-trust-gateway_messages
array
zero-trust-gateway_api-response-common-failure
object
4 properties 4 required
zero-trust-gateway_certificates
object
12 properties
zero-trust-gateway_generate-cert-request
object
1 property
zero-trust-gateway_timestamp
string
zero-trust-gateway_api-response-common
object
3 properties 3 required
zero-trust-gateway_binding_status
string
The deployment status of the certificate on Cloudflare's edge. Certificates in the 'active' state may be used for Gateway TLS interception.
zero-trust-gateway_identifier
string
zero-trust-gateway_response_collection
zero-trust-gateway_api-response-single
object
zero-trust-gateway_result_info
object
4 properties
zero-trust-gateway_single_response
zero-trust-gateway_type
string
The type of certificate, either BYO-PKI (custom) or Gateway-managed.
zero-trust-gateway_uuid
string
Certificate UUID tag.
zero-trust-gateway_api-response-collection
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-zero-trust-certificates-api-openapi.yml Raw ↑