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

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

This API exposes 2 operations across 1 path, and defines 13 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 13 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=ListSSHPublicKeys 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=ListSSHPublicKeys 2
GET
/#Action=ListSSHPublicKeys
Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list. The SSH public keys returned by this operation are used only…
GET_ListSSHPublicKeys 12 params → 200480
POST
/#Action=ListSSHPublicKeys
Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list. The SSH public keys returned by this operation are used only…
POST_ListSSHPublicKeys 11 params body → 200480

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are SSHPublicKeyMetadata (4 properties), ListSSHPublicKeysRequest (3 properties), ListSSHPublicKeysResponse (3 properties). Each schema is shown below with its type and property counts.

statusType
string
userNameType
string
publicKeyIdType
string
responseMarkerType
string
SSHPublicKeyMetadata
object
Contains information about an SSH public key, without the key's body or fingerprint. This data type is used as a response element in the ListSSHPublicKeys oper…
4 properties 4 required
ListSSHPublicKeysResponse
object
Contains the response to a successful ListSSHPublicKeys request.
3 properties
markerType
string
booleanType
boolean
SSHPublicKeyListType
array
NoSuchEntityException
dateType
string
ListSSHPublicKeysRequest
object
3 properties
maxItemsType
integer

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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