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 Clientcertificates API

The Clientcertificates API from APIs.io Engineering Platform — 2 operation(s) for clientcertificates.

This API exposes 5 operations across 2 paths, and defines 14 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 2 paths 14 schemas 1 DELETE2 GET1 PATCH1 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 Clientcertificates 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 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Clientcertificates 5
DELETE
/clientcertificates/{clientcertificate_id}
Deletes the ClientCertificate resource.
DeleteClientCertificate 8 params → 202480481482483484
GET
/clientcertificates/{clientcertificate_id}
Gets information about the current ClientCertificate resource.
GetClientCertificate 8 params → 200480481482483
PATCH
/clientcertificates/{clientcertificate_id}
Changes information about an ClientCertificate resource.
UpdateClientCertificate 8 params body → 200480481482483484485
POST
/clientcertificates
Generates a ClientCertificate resource.
GenerateClientCertificate 7 params body → 201480481482483484
GET
/clientcertificates
Gets a collection of ClientCertificate resources.
GetClientCertificates 9 params → 200480481482483

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are ClientCertificate (6 properties), PatchOperation (4 properties), ClientCertificates (2 properties). Each schema is shown below with its type and property counts.

TooManyRequestsException
NotFoundException
ListOfClientCertificate
array
Op
string
UnauthorizedException
ClientCertificates
object
Represents a collection of ClientCertificate resources.
2 properties
ConflictException
Timestamp
string
BadRequestException
PatchOperation
object
For more information about supported patch operations, see Patch Operations .
4 properties
LimitExceededException
String
string
ClientCertificate
object
Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
6 properties
MapOfStringToString
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-clientcertificates-api-openapi.yml Raw ↑