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 #Action=GetServerCertificate API

The #Action=GetServerCertificate API from APIs.io Engineering Platform — 1 operation(s) for #action=getservercertificate.

This API exposes 2 operations across 1 path, and defines 17 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.

2 operations 1 paths 17 schemas 1 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 #Action=GetServerCertificate 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 2

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

#Action=GetServerCertificate 2
GET
/#Action=GetServerCertificate
Retrieves information about the specified server certificate stored in IAM. For more information about working with server certificates, see Working with server certificates in the IAM User Guide . T…
GET_GetServerCertificate 10 params → 200480481
POST
/#Action=GetServerCertificate
Retrieves information about the specified server certificate stored in IAM. For more information about working with server certificates, see Working with server certificates in the IAM User Guide . T…
POST_GetServerCertificate 9 params body → 200480481

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are ServerCertificateMetadata (6 properties), ServerCertificate (4 properties), Tag (2 properties), GetServerCertificateRequest (1 property). Each schema is shown below with its type and property counts.

tagListType
array
Tag
object
A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see Tagging IAM resources i…
2 properties 2 required
arnType
string
The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources. For more information about ARNs, go to Amazon Resource Names (AR…
pathType
string
GetServerCertificateRequest
object
1 property 1 required
tagKeyType
string
tagValueType
string
GetServerCertificateResponse
object
Contains the response to a successful GetServerCertificate request.
1 property 1 required
idType
string
certificateChainType
string
certificateBodyType
string
serverCertificateNameType
string
NoSuchEntityException
dateType
string
ServiceFailureException
ServerCertificateMetadata
object
Contains information about a server certificate without its certificate body, certificate chain, and private key. This data type is used as a response element…
6 properties 4 required
ServerCertificate
object
Contains information about a server certificate. This data type is used as a response element in the GetServerCertificate operation.
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-action-getservercertificate-api-openapi.yml Raw ↑