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

The Apikeys API from APIs.io Engineering Platform — 2 operation(s) for apikeys.

This API exposes 5 operations across 2 paths, 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.

5 operations 2 paths 17 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 Apikeys 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.

Apikeys 5
POST
/apikeys
Create an ApiKey resource.
CreateApiKey 7 params body → 201480481482483484485
GET
/apikeys
Gets information about the current ApiKeys resource.
GetApiKeys 12 params → 200480481482483
DELETE
/apikeys/{api_Key}
Deletes the ApiKey resource.
DeleteApiKey 8 params → 202480481482483484
GET
/apikeys/{api_Key}
Gets information about the current ApiKey resource.
GetApiKey 9 params → 200480481482483
PATCH
/apikeys/{api_Key}
Changes information about an ApiKey resource.
UpdateApiKey 8 params body → 200480481482483484485

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are ApiKey (10 properties), PatchOperation (4 properties), ApiKeys (3 properties), StageKey (2 properties). Each schema is shown below with its type and property counts.

TooManyRequestsException
NotFoundException
Op
string
UnauthorizedException
Boolean
boolean
ConflictException
Timestamp
string
ApiKeys
object
Represents a collection of API keys as represented by an ApiKeys resource.
3 properties
PatchOperation
object
For more information about supported patch operations, see Patch Operations .
4 properties
BadRequestException
LimitExceededException
ListOfApiKey
array
String
string
StageKey
object
A reference to a unique stage identified in the format {restApiId}/{stage} .
2 properties
ListOfString
array
MapOfStringToString
object
ApiKey
object
A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which…
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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