Amazon API Gateway Api Gateway Keys API

The Api Gateway Keys API from Amazon API Gateway — 2 operation(s) for api gateway keys.

GitHub OpenAPI

Operations 4

POST /usageplans/{usagePlanId}/keys Create Usage Plan Key #
GET /usageplans/{usagePlanId}/keys Get Usage Plan Keys #
DELETE /usageplans/{usagePlanId}/keys/{keyId} Delete Usage Plan Key #
GET /usageplans/{usagePlanId}/keys/{keyId} Get Usage Plan Key #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/aws-api-gateway:aws-api-gateway-keys-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

aws-api-gateway-keys-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon API Gateway Keys API
  version: '2015-07-09'
  description: Generated from AWS's published Smithy model for Amazon API Gateway. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /usageplans/{usagePlanId}/keys:
    post:
      operationId: CreateUsagePlanKey
      summary: Create Usage Plan Key
      description: Creates a usage plan key for adding an existing API key to a usage plan.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsagePlanKey'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '429':
          description: LimitExceededException; TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUsagePlanKeyRequest'
      tags:
      - Keys
    get:
      operationId: GetUsagePlanKeys
      summary: Get Usage Plan Keys
      description: Gets all the usage plan keys representing the API keys added to a specified usage plan.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsagePlanKeys'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetUsagePlanKeysRequest'
      tags:
      - Keys
  /usageplans/{usagePlanId}/keys/{keyId}:
    delete:
      operationId: DeleteUsagePlanKey
      summary: Delete Usage Plan Key
      description: Deletes a usage plan key and remove the underlying API key from the associated usage plan.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteUsagePlanKeyRequest'
      tags:
      - Keys
    get:
      operationId: GetUsagePlanKey
      summary: Get Usage Plan Key
      description: Gets a usage plan key of a given key identifier.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsagePlanKey'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '401':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetUsagePlanKeyRequest'
      tags:
      - Keys
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: apigateway
  schemas:
    BadRequestException:
      type: object
      properties:
        message:
          type: string
    ConflictException:
      type: object
      properties:
        message:
          type: string
    CreateUsagePlanKeyRequest:
      type: object
      properties:
        usagePlanId:
          type: string
          description: The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey
            resource representing a plan customer.
        keyId:
          type: string
          description: The identifier of a UsagePlanKey resource for a plan customer.
        keyType:
          type: string
          description: The type of a UsagePlanKey resource for a plan customer.
      required:
      - usagePlanId
      - keyId
      - keyType
    DeleteUsagePlanKeyRequest:
      type: object
      properties:
        usagePlanId:
          type: string
          description: The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey
            resource representing a plan customer.
        keyId:
          type: string
          description: The Id of the UsagePlanKey resource to be deleted.
      required:
      - usagePlanId
      - keyId
    GetUsagePlanKeyRequest:
      type: object
      properties:
        usagePlanId:
          type: string
          description: The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey
            resource representing a plan customer.
        keyId:
          type: string
          description: The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.
      required:
      - usagePlanId
      - keyId
    GetUsagePlanKeysRequest:
      type: object
      properties:
        usagePlanId:
          type: string
          description: The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey
            resource representing a plan customer.
        position:
          type: string
          description: The current pagination position in the paged result set.
        limit:
          type: integer
          description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
        nameQuery:
          type: string
          description: A query parameter specifying the name of the to-be-returned usage plan keys.
      required:
      - usagePlanId
    LimitExceededException:
      type: object
      properties:
        retryAfterSeconds:
          type: string
        message:
          type: string
    NotFoundException:
      type: object
      properties:
        message:
          type: string
    TooManyRequestsException:
      type: object
      properties:
        retryAfterSeconds:
          type: string
        message:
          type: string
    UnauthorizedException:
      type: object
      properties:
        message:
          type: string
    UsagePlanKey:
      type: object
      properties:
        id:
          type: string
          description: The Id of a usage plan key.
        type:
          type: string
          description: The type of a usage plan key. Currently, the valid key type is API_KEY.
        value:
          type: string
          description: The value of a usage plan key.
        name:
          type: string
          description: The name of a usage plan key.
    UsagePlanKeys:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/UsagePlanKey'
          description: The current page of elements from this collection.
        position:
          type: string
          description: The current pagination position in the paged result set.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/api-gateway/service/2015-07-09/api-gateway-2015-07-09.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)