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=GetSSHPublicKey API

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

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

2 operations 1 paths 12 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=GetSSHPublicKey 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=GetSSHPublicKey 2
GET
/#Action=GetSSHPublicKey
Retrieves the specified SSH public key, including metadata about the key. The SSH public key retrieved by this operation is used only for authenticating the associated IAM user to an CodeCommit repos…
GET_GetSSHPublicKey 12 params → 200480481
POST
/#Action=GetSSHPublicKey
Retrieves the specified SSH public key, including metadata about the key. The SSH public key retrieved by this operation is used only for authenticating the associated IAM user to an CodeCommit repos…
POST_GetSSHPublicKey 9 params body → 200480481

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are SSHPublicKey (6 properties), GetSSHPublicKeyRequest (3 properties), GetSSHPublicKeyResponse (1 property). Each schema is shown below with its type and property counts.

encodingType
string
statusType
string
GetSSHPublicKeyResponse
object
Contains the response to a successful GetSSHPublicKey request.
1 property
publicKeyIdType
string
userNameType
string
UnrecognizedPublicKeyEncodingException
publicKeyMaterialType
string
NoSuchEntityException
dateType
string
publicKeyFingerprintType
string
GetSSHPublicKeyRequest
object
3 properties 3 required
SSHPublicKey
object
Contains information about an SSH public key. This data type is used as a response element in the GetSSHPublicKey and UploadSSHPublicKey operations.
6 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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