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 Usage Plans API

The Usage Plans API from APIs.io Engineering Platform — 6 operation(s) for usage plans.

APIs.io Engineering Platform Usage Plans API is one of 309 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://rds.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Usage Plans 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.

Usage Plans 11
POST
/usageplans
Create usage plan
CreateUsagePlan 7 params body → 201480481482483484485
GET
/usageplans
Get usage plans
GetUsagePlans 10 params → 200480481482483
POST
/usageplans/{usageplanId}/keys
Create usage plan key
CreateUsagePlanKey 8 params body → 201480481482483484485
GET
/usageplans/{usageplanId}/keys
Get usage plan keys
GetUsagePlanKeys 11 params → 200480481482483
DELETE
/usageplans/{usageplanId}
Delete usage plan
DeleteUsagePlan 8 params → 202480481482483484
GET
/usageplans/{usageplanId}
Get usage plan
GetUsagePlan 8 params → 200480481482483
PATCH
/usageplans/{usageplanId}
Update usage plan
UpdateUsagePlan 8 params body → 200480481482483484485
DELETE
/usageplans/{usageplanId}/keys/{keyId}
Delete usage plan key
DeleteUsagePlanKey 9 params → 202480481482483484
GET
/usageplans/{usageplanId}/keys/{keyId}
Get usage plan key
GetUsagePlanKey 9 params → 200480481482483
GET
/usageplans/{usageplanId}/usage#startDate&endDate
Get usage
GetUsage 13 params → 200480481482483
PATCH
/usageplans/{usageplanId}/keys/{keyId}/usage
Update usage
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), UsagePlanKey (4 properties), PatchOperation (4 properties). Each schema is shown below with its type and property counts.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-usage-plans-api-openapi.yml Raw ↑

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

Amazon Relational Database Service
Amazon Simple Storage Service
EasyCron
APIs.io Engineering Platform Access Application-Scoped Policies API
APIs.io Engineering Platform Access Applications API
APIs.io Engineering Platform Access Authentication Logs API
APIs.io Engineering Platform Access Bookmark Applications (Deprecated) API
APIs.io Engineering Platform Access Custom Pages API
APIs.io Engineering Platform Access Groups API
APIs.io Engineering Platform Access Identity Providers API
APIs.io Engineering Platform Access Key Configuration API
Where this information came from

This is an independent, third-party profile of APIs.io Engineering Platform Usage Plans 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.