capabilities.work

Create an API Key and Usage Plan

A 3-step recipe with Amazon API Gateway. We can help you get access.

Recipe · 3 steps

Create an API Key and Usage Plan

with Amazon API Gateway

Create an API key and a usage plan, then confirm the plan exists.

  1. Create an enabled API key that callers will present to the gateway.
  2. Create a usage plan with throttle and quota settings to govern how the API key may be used.
  3. List usage plans to confirm the new plan was registered.
What you'll need to have ready
  • keyName: Name of the API key to create.
  • keyDescription: Optional description for the API key.
  • planName: Name of the usage plan to create.
  • planDescription: Optional description for the usage plan.
  • burstLimit: Throttle burst limit for the usage plan.
  • rateLimit: Throttle steady-state rate limit (requests per second).
  • quotaLimit: Maximum number of requests allowed in the quota period.
  • quotaPeriod: Quota period (DAY, WEEK, or MONTH).
For your developer

Arazzo workflow aws-api-gateway:create-api-key-and-usage-plan, 3 operations: CreateApiKey → CreateUsagePlan → GetUsagePlans. Specs on APIs.io.

More recipes with Amazon API Gateway

AWS API Gateway Add a Method and RedeployAWS API Gateway Audit an HTTP API SurfaceAWS API Gateway Build an HTTP APIAWS API Gateway Build a WebSocket APIAWS API Gateway Decommission an HTTP APIAWS API Gateway Deploy an HTTP API to a New StageAWS API Gateway Inspect a REST API MethodAWS API Gateway Provision a Metered REST APIAWS API Gateway Provision and Deploy a REST APIAWS API Gateway Redeploy a REST API Stage