Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Apikeys paths: /apikeys: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateApiKey description: 'Create an ApiKey resource. ' responses: '201': description: Success content: application/json: schema: $ref: '#/components/schemas/ApiKey' '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' '481': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' '482': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '483': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' '484': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' parameters: [] requestBody: required: true content: application/json: schema: type: object properties: name: description: The name of the ApiKey. type: string description: description: The description of the ApiKey. type: string enabled: description: Specifies whether the ApiKey can be used by callers. type: boolean generateDistinctId: description: Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
type: boolean
value:
description: Specifies a value of the API key.
type: string
stageKeys:
description: DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
type: array
items:
$ref: '#/components/schemas/StageKey'
customerId:
description: An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
type: string
tags:
description: The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
type: object
additionalProperties:
$ref: '#/components/schemas/String'
tags:
- Apikeys
get:
operationId: GetApiKeys
description: Gets information about the current ApiKeys resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKeys'
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'481':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'482':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'483':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
parameters:
- name: position
in: query
required: false
description: The current pagination position in the paged result set.
schema:
type: string
- name: limit
in: query
required: false
description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
schema:
type: integer
- name: name
in: query
required: false
description: The name of queried API keys.
schema:
type: string
- name: customerId
in: query
required: false
description: The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.
schema:
type: string
- name: includeValues
in: query
required: false
description: A boolean flag to specify whether (true) or not (false) the result contains key values.
schema:
type: boolean
tags:
- Apikeys
/apikeys/{api_Key}:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
delete:
operationId: DeleteApiKey
description: Deletes the ApiKey resource.
responses:
'202':
description: Success
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'482':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'483':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'484':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
parameters:
- name: api_Key
in: path
required: true
description: The identifier of the ApiKey resource to be deleted.
schema:
type: string
tags:
- Apikeys
get:
operationId: GetApiKey
description: Gets information about the current ApiKey resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKey'
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'481':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'482':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'483':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
parameters:
- name: api_Key
in: path
required: true
description: The identifier of the ApiKey resource.
schema:
type: string
- name: includeValue
in: query
required: false
description: A boolean flag to specify whether (true) or not (false) the result contains the key value.
schema:
type: boolean
tags:
- Apikeys
patch:
operationId: UpdateApiKey
description: Changes information about an ApiKey resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKey'
'480':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestException'
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'482':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'483':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'484':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'485':
description: TooManyRequestsException
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsException'
parameters:
- name: api_Key
in: path
required: true
description: The identifier of the ApiKey resource to be updated.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
patchOperations:
description: A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.
type: array
items:
$ref: '#/components/schemas/PatchOperation'
tags:
- Apikeys
components:
parameters:
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
schemas:
TooManyRequestsException: {}
NotFoundException: {}
Op:
type: string
enum:
- add
- remove
- replace
- move
- copy
- test
UnauthorizedException: {}
Boolean:
type: boolean
ConflictException: {}
Timestamp:
type: string
format: date-time
ApiKeys:
type: object
properties:
warnings:
allOf:
- $ref: '#/components/schemas/ListOfString'
- description: A list of warning messages logged during the import of API keys when the failOnWarnings option is set to true.
position:
$ref: '#/components/schemas/String'
items:
allOf:
- $ref: '#/components/schemas/ListOfApiKey'
- xml:
name: item
description: The current page of elements from this collection.
description: Represents a collection of API keys as represented by an ApiKeys resource.
PatchOperation:
type: object
properties:
op:
allOf:
- $ref: '#/components/schemas/Op'
- description: An update operation to be performed with this PATCH request. The valid value can be add, remove, replace or copy. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message..
path:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The op operation''s target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {"name":"value"}, the path for this property is /name. If the name property value is a JSON object (e.g., {"name": {"child/name": "child-value"}}), the path for the child/name property will be /name/child~1name. Any slash ("/") character appearing in path names must be escaped with "~1", as shown in the example above. Each op operation can have only one path associated with it.'
value:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., ''{"a": ...}''.'
from:
allOf:
- $ref: '#/components/schemas/String'
- description: The copy update operation's source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with "op":"copy", "from":"/canarySettings/deploymentId" and "path":"/deploymentId".
description: For more information about supported patch operations, see Patch Operations.
BadRequestException: {}
LimitExceededException: {}
ListOfApiKey:
type: array
items:
$ref: '#/components/schemas/ApiKey'
String:
type: string
StageKey:
type: object
properties:
restApiId:
allOf:
- $ref: '#/components/schemas/String'
- description: The string identifier of the associated RestApi.
stageName:
allOf:
- $ref: '#/components/schemas/String'
- description: The stage name associated with the stage key.
description: A reference to a unique stage identified in the format {restApiId}/{stage}.
ListOfString:
type: array
items:
$ref: '#/components/schemas/String'
MapOfStringToString:
type: object
additionalProperties:
$ref: '#/components/schemas/String'
ApiKey:
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/String'
- description: The identifier of the API Key.
value:
allOf:
- $ref: '#/components/schemas/String'
- description: The value of the API Key.
name:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the API Key.
customerId:
allOf:
- $ref: '#/components/schemas/String'
- description: An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description of the API Key.
enabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Specifies whether the API Key can be used by callers.
createdDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The timestamp when the API Key was created.
lastUpdatedDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The timestamp when the API Key was last updated.
stageKeys:
allOf:
- $ref: '#/components/schemas/ListOfString'
- description: A list of Stage resources that are associated with the ApiKey resource.
tags:
allOf:
- $ref: '#/components/schemas/MapOfStringToString'
- description: The collection of tags. Each tag element is associated with a given resource.
description: A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true