This API exposes
11 operations
across 6 paths,
and defines 29 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.
11 operations6 paths29 schemas2 DELETE5 GET2 PATCH2 POST
Metadata
The identity and technical contract details declared by the specification.
APIs.io Engineering Platform Usageplans 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 11
Across 6 paths, the API surfaces 11 operations — 2 DELETE, 5 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Usageplans 11
POST
/usageplans
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
DeleteUsagePlanKey9 params→ 202480481482483484
GET
/usageplans/{usageplanId}/keys/{keyId}
Gets a usage plan key of a given key identifier.
GetUsagePlanKey9 params→ 200480481482483
GET
/usageplans/{usageplanId}/usage#startDate&endDate
Gets the usage data of a usage plan in a specified time interval.
GetUsage13 params→ 200480481482483
PATCH
/usageplans/{usageplanId}/keys/{keyId}/usage
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
UpdateUsage9 paramsbody→ 200480481482483484485
Schemas 29
The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are UsagePlan (8 properties), Usage (5 properties), PatchOperation (4 properties), UsagePlanKey (4 properties). Each schema is shown below with its type and property counts.
TooManyRequestsException
QuotaPeriodType
string
NotFoundException
Double
number
Op
string
ListOfUsage
array
Integer
integer
UnauthorizedException
Usage
object
Represents the usage data of a usage plan.
5 properties
ConflictException
MapOfKeyUsages
object
Long
integer
BadRequestException
PatchOperation
object
For more information about supported patch operations, see Patch Operations .
4 properties
LimitExceededException
ApiStage
object
API stage name of the associated API stage in a usage plan.
3 properties
MapOfApiStageThrottleSettings
object
ListOfUsagePlanKey
array
ListOfUsagePlan
array
ListOfLong
array
String
string
MapOfStringToString
object
UsagePlan
object
Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases client…
8 properties
ThrottleSettings
object
The API request rate limits.
2 properties
UsagePlanKey
object
Represents a usage plan key to identify a plan customer.
4 properties
UsagePlans
object
Represents a collection of usage plans for an AWS account.
2 properties
UsagePlanKeys
object
Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.
2 properties
ListOfApiStage
array
QuotaSettings
object
Quotas configured for a usage plan.
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
