How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Usageplans API

The Usageplans API from APIs.io Engineering Platform — 6 operation(s) for usageplans.

APIs.io Engineering Platform Usageplans API is one of 471 APIs that APIs.io Engineering Platform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Usage Plans. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 11 operations across 6 paths, and defines 29 schemas. It is described by OpenAPI 3.2.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 operations 6 paths 29 schemas 2 DELETE5 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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 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.
CreateUsagePlan 7 params body → 201480481482483484485
GET
/usageplans
Gets all the usage plans of the caller's account.
GetUsagePlans 10 params → 200480481482483
POST
/usageplans/{usageplanId}/keys
Creates a usage plan key for adding an existing API key to a usage plan.
CreateUsagePlanKey 8 params body → 201480481482483484485
GET
/usageplans/{usageplanId}/keys
Gets all the usage plan keys representing the API keys added to a specified usage plan.
GetUsagePlanKeys 11 params → 200480481482483
DELETE
/usageplans/{usageplanId}
Deletes a usage plan of a given plan Id.
DeleteUsagePlan 8 params → 202480481482483484
GET
/usageplans/{usageplanId}
Gets a usage plan of a given plan identifier.
GetUsagePlan 8 params → 200480481482483
PATCH
/usageplans/{usageplanId}
Updates a usage plan of a given plan Id.
UpdateUsagePlan 8 params body → 200480481482483484485
DELETE
/usageplans/{usageplanId}/keys/{keyId}
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
DeleteUsagePlanKey 9 params → 202480481482483484
GET
/usageplans/{usageplanId}/keys/{keyId}
Gets a usage plan key of a given key identifier.
GetUsagePlanKey 9 params → 200480481482483
GET
/usageplans/{usageplanId}/usage#startDate&endDate
Gets the usage data of a usage plan in a specified time interval.
GetUsage 13 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.
UpdateUsage 9 params body → 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.

ConflictException
UsagePlanKey
object
Represents a usage plan key to identify a plan customer.
4 properties
PatchOperation
object
For more information about supported patch operations, see Patch Operations .
4 properties
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
MapOfStringToString
object
ListOfUsagePlan
array
ApiStage
object
API stage name of the associated API stage in a usage plan.
3 properties
Long
integer
Usage
object
Represents the usage data of a usage plan.
5 properties
UsagePlans
object
Represents a collection of usage plans for an AWS account.
2 properties
LimitExceededException
ListOfApiStage
array
MapOfApiStageThrottleSettings
object
MapOfKeyUsages
object
UnauthorizedException
String
string
NotFoundException
Double
number
ListOfUsagePlanKey
array
QuotaSettings
object
Quotas configured for a usage plan.
3 properties
Op
string
ThrottleSettings
object
The API request rate limits.
2 properties
ListOfUsage
array
Integer
integer
BadRequestException
TooManyRequestsException
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
ListOfLong
array
QuotaPeriodType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs APIs.io Engineering Platform publishes across the network.

EasyCron
APIs.io Engineering Platform 2014 11 13 API
APIs.io Engineering Platform 2015 03 31 API
APIs.io Engineering Platform 2016 08 19 API
APIs.io Engineering Platform 2017 03 31 API
APIs.io Engineering Platform 2017 10 31 API
APIs.io Engineering Platform 2018 10 31 API
APIs.io Engineering Platform 2019 09 25 API
APIs.io Engineering Platform 2019 09 30 API
APIs.io Engineering Platform 2020 04 22 API
APIs.io Engineering Platform 2020 06 30 API
Where this information came from

This is an independent, third-party profile of APIs.io Engineering Platform Usageplans API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.