Amazon Web Services, Inc.

Amazon API Gateway

Amazon API Gateway Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon API Gateway
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 Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

Endpoints 122

  • GETGet api keys/apikeys?position=string&limit=0&name=string&customerId=string&includeValues=trueGets information about the current ApiKeys resource.
  • POSTImport api keys/apikeys?mode=importImport API keys from an external source, such as a CSV-formatted file.
  • GETGet authorizers/restapis/:restApiId/authorizers?position=string&limit=0Describe an existing Authorizers resource.
  • POSTCreate authorizer/restapis/:restApiId/authorizersAdds a new Authorizer resource to an existing RestApi resource.
  • GETGet base path mappings/domainnames/:domainName/basepathmappings?domainNameId=string&position=string&limit=0Represents a collection of BasePathMapping resources.
  • POSTCreate base path mapping/domainnames/:domainName/basepathmappings?domainNameId=stringCreates a new BasePathMapping resource.
  • GETGet deployments/restapis/:restApiId/deployments?position=string&limit=0Gets information about a Deployments collection.
  • POSTCreate deployment/restapis/:restApiId/deploymentsCreates a Deployment resource, which makes a specified RestApi callable over the internet.
  • GETGet documentation parts/restapis/:restApiId/documentation/parts?type=string&name=string&path=string&position=string&limit=0&locationStatus=stringGets documentation parts.
  • PUTImport documentation parts/restapis/:restApiId/documentation/parts?mode=string&failonwarnings=trueImports documentation parts
  • POSTCreate documentation part/restapis/:restApiId/documentation/partsCreates a documentation part.
  • GETGet documentation versions/restapis/:restApiId/documentation/versions?position=string&limit=0Gets documentation versions.
  • POSTCreate documentation version/restapis/:restApiId/documentation/versionsCreates a documentation version
  • GETGet domain names/domainnames?position=string&limit=0&resourceOwner=stringRepresents a collection of DomainName resources.
  • POSTCreate domain name/domainnamesCreates a new domain name.
  • GETGet domain name access associations/domainnameaccessassociations?position=string&limit=0&resourceOwner=stringRepresents a collection on DomainNameAccessAssociations resources.
  • POSTCreate domain name access association/domainnameaccessassociationsCreates a domain name access association resource between an access association source and a private custom domain name.
  • GETGet models/restapis/:restApiId/models?position=string&limit=0Describes existing Models defined for a RestApi resource.
  • POSTCreate model/restapis/:restApiId/modelsAdds a new Model resource to an existing RestApi resource.
  • GETGet request validators/restapis/:restApiId/requestvalidators?position=string&limit=0Gets the RequestValidators collection of a given RestApi.
  • POSTCreate request validator/restapis/:restApiId/requestvalidatorsCreates a RequestValidator of a given RestApi.
  • POSTCreate resource/restapis/:restApiId/resources/:parentIdCreates a Resource resource.
  • GETGet rest apis/restapis?position=string&limit=0Lists the RestApis resources for your collection.
  • POSTImport rest api/restapis?mode=import&failonwarnings=trueA feature of the API Gateway control service for creating a new API from an external API definition file.
  • GETGet stages/restapis/:restApiId/stages?deploymentId=stringGets information about one or more Stage resources.
  • POSTCreate stage/restapis/:restApiId/stagesCreates a new Stage resource that references a pre-existing Deployment for the API.
  • GETGet usage plans/usageplans?position=string&keyId=string&limit=0Gets all the usage plans of the caller's account.
  • POSTCreate usage plan/usageplansCreates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
  • GETGet usage plan keys/usageplans/:usagePlanId/keys?position=string&limit=0&name=stringGets all the usage plan keys representing the API keys added to a specified usage plan.
  • POSTCreate usage plan key/usageplans/:usagePlanId/keysCreates a usage plan key for adding an existing API key to a usage plan.
  • GETGet vpc links/vpclinks?position=string&limit=0Gets the VpcLinks collection under the caller's account in a selected region.
  • POSTCreate vpc link/vpclinksCreates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become…
  • GETGet api key/apikeys/:apiKey?includeValue=trueGets information about the current ApiKey resource.
  • DELETEDelete api key/apikeys/:apiKeyDeletes the ApiKey resource.
  • PATCHUpdate api key/apikeys/:apiKeyChanges information about an ApiKey resource.
  • GETGet authorizer/restapis/:restApiId/authorizers/:authorizerIdDescribe an existing Authorizer resource.
  • POSTTest invoke authorizer/restapis/:restApiId/authorizers/:authorizerIdSimulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
  • DELETEDelete authorizer/restapis/:restApiId/authorizers/:authorizerIdDeletes an existing Authorizer resource.
  • PATCHUpdate authorizer/restapis/:restApiId/authorizers/:authorizerIdUpdates an existing Authorizer resource.
  • GETGet base path mapping/domainnames/:domainName/basepathmappings/:basePath?domainNameId=stringDescribe a BasePathMapping resource.
  • DELETEDelete base path mapping/domainnames/:domainName/basepathmappings/:basePath?domainNameId=stringDeletes the BasePathMapping resource.
  • PATCHUpdate base path mapping/domainnames/:domainName/basepathmappings/:basePath?domainNameId=stringChanges information about the BasePathMapping resource.
  • GETGet client certificate/clientcertificates/:clientCertificateIdGets information about the current ClientCertificate resource.
  • DELETEDelete client certificate/clientcertificates/:clientCertificateIdDeletes the ClientCertificate resource.
  • PATCHUpdate client certificate/clientcertificates/:clientCertificateIdChanges information about an ClientCertificate resource.
  • GETGet deployment/restapis/:restApiId/deployments/:deploymentId?embed=Gets information about a Deployment resource.
  • DELETEDelete deployment/restapis/:restApiId/deployments/:deploymentIdDeletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
  • PATCHUpdate deployment/restapis/:restApiId/deployments/:deploymentIdChanges information about a Deployment resource.
  • GETGet documentation part/restapis/:restApiId/documentation/parts/:documentationPartIdGets a documentation part.
  • DELETEDelete documentation part/restapis/:restApiId/documentation/parts/:documentationPartIdDeletes a documentation part
  • PATCHUpdate documentation part/restapis/:restApiId/documentation/parts/:documentationPartIdUpdates a documentation part.
  • GETGet documentation version/restapis/:restApiId/documentation/versions/:documentationVersionGets a documentation version.
  • DELETEDelete documentation version/restapis/:restApiId/documentation/versions/:documentationVersionDeletes a documentation version.
  • PATCHUpdate documentation version/restapis/:restApiId/documentation/versions/:documentationVersionUpdates a documentation version.
  • GETGet domain name/domainnames/:domainName?domainNameId=stringRepresents a domain name that is contained in a simpler, more intuitive URL that can be called.
  • DELETEDelete domain name/domainnames/:domainName?domainNameId=stringDeletes the DomainName resource.
  • PATCHUpdate domain name/domainnames/:domainName?domainNameId=stringChanges information about the DomainName resource.
  • DELETEDelete domain name access association/domainnameaccessassociations/:domainNameAccessAssociationArnDeletes the DomainNameAccessAssociation resource. Only the AWS account that created the DomainNameAccessAssociation resource can delete it. To stop an access…
  • GETGet gateway response/restapis/:restApiId/gatewayresponses/:responseTypeGets a GatewayResponse of a specified response type on the given RestApi.
  • PUTPut gateway response/restapis/:restApiId/gatewayresponses/:responseTypeCreates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
  • DELETEDelete gateway response/restapis/:restApiId/gatewayresponses/:responseTypeClears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
  • PATCHUpdate gateway response/restapis/:restApiId/gatewayresponses/:responseTypeUpdates a GatewayResponse of a specified response type on the given RestApi.
  • GETGet integration/restapis/:restApiId/resources/:resourceId/methods/:httpMethod/integrationGet the integration settings.
  • PUTPut integration/restapis/:restApiId/resources/:resourceId/methods/:httpMethod/integrationSets up a method's integration.
  • DELETEDelete integration/restapis/:restApiId/resources/:resourceId/methods/:httpMethod/integrationRepresents a delete integration.
  • PATCHUpdate integration/restapis/:restApiId/resources/:resourceId/methods/:httpMethod/integrationRepresents an update integration.
  • GETGet integration response/restapis/:restApiId/resources/:resourceId/methods/:httpMethod/integration/responses/:statusCodeRepresents a get integration response.
  • PUTPut integration response/restapis/:restApiId/resources/:resourceId/methods/:httpMethod/integration/responses/:statusCodeRepresents a put integration.
  • DELETEDelete integration response/restapis/:restApiId/resources/:resourceId/methods/:httpMethod/integration/responses/:statusCodeRepresents a delete integration response.
  • PATCHUpdate integration response/restapis/:restApiId/resources/:resourceId/methods/:httpMethod/integration/responses/:statusCodeRepresents an update integration response.
  • GETGet method/restapis/:restApiId/resources/:resourceId/methods/:httpMethodDescribe an existing Method resource.
  • PUTPut method/restapis/:restApiId/resources/:resourceId/methods/:httpMethodAdd a method to an existing Resource resource.
  • POSTTest invoke method/restapis/:restApiId/resources/:resourceId/methods/:httpMethodSimulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
  • DELETEDelete method/restapis/:restApiId/resources/:resourceId/methods/:httpMethodDeletes an existing Method resource.
  • PATCHUpdate method/restapis/:restApiId/resources/:resourceId/methods/:httpMethodUpdates an existing Method resource.
  • GETGet method response/restapis/:restApiId/resources/:resourceId/methods/:httpMethod/responses/:statusCodeDescribes a MethodResponse resource.
  • PUTPut method response/restapis/:restApiId/resources/:resourceId/methods/:httpMethod/responses/:statusCodeAdds a MethodResponse to an existing Method resource.
  • DELETEDelete method response/restapis/:restApiId/resources/:resourceId/methods/:httpMethod/responses/:statusCodeDeletes an existing MethodResponse resource.
  • PATCHUpdate method response/restapis/:restApiId/resources/:resourceId/methods/:httpMethod/responses/:statusCodeUpdates an existing MethodResponse resource.
  • GETGet model/restapis/:restApiId/models/:modelName?flatten=trueDescribes an existing model defined for a RestApi resource.
  • DELETEDelete model/restapis/:restApiId/models/:modelNameDeletes a model.
  • PATCHUpdate model/restapis/:restApiId/models/:modelNameChanges information about a model. The maximum size of the model is 400 KB.
  • GETGet request validator/restapis/:restApiId/requestvalidators/:requestValidatorIdGets a RequestValidator of a given RestApi.
  • DELETEDelete request validator/restapis/:restApiId/requestvalidators/:requestValidatorIdDeletes a RequestValidator of a given RestApi.
  • PATCHUpdate request validator/restapis/:restApiId/requestvalidators/:requestValidatorIdUpdates a RequestValidator of a given RestApi.
  • GETGet resource/restapis/:restApiId/resources/:resourceId?embed=Lists information about a resource.
  • DELETEDelete resource/restapis/:restApiId/resources/:resourceIdDeletes a Resource resource.
  • PATCHUpdate resource/restapis/:restApiId/resources/:resourceIdChanges information about a Resource resource.
  • GETGet rest api/restapis/:restApiIdLists the RestApi resource in the collection.
  • PUTPut rest api/restapis/:restApiId?mode=string&failonwarnings=trueA feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging…
  • DELETEDelete rest api/restapis/:restApiIdDeletes the specified API.
  • PATCHUpdate rest api/restapis/:restApiIdChanges information about the specified API.
  • GETGet stage/restapis/:restApiId/stages/:stageNameGets information about a Stage resource.
  • DELETEDelete stage/restapis/:restApiId/stages/:stageNameDeletes a Stage resource.
  • PATCHUpdate stage/restapis/:restApiId/stages/:stageNameChanges information about a Stage resource.
  • GETGet usage plan/usageplans/:usagePlanIdGets a usage plan of a given plan identifier.
  • DELETEDelete usage plan/usageplans/:usagePlanIdDeletes a usage plan of a given plan Id.
  • PATCHUpdate usage plan/usageplans/:usagePlanIdUpdates a usage plan of a given plan Id.
  • GETGet usage plan key/usageplans/:usagePlanId/keys/:keyIdGets a usage plan key of a given key identifier.
  • DELETEDelete usage plan key/usageplans/:usagePlanId/keys/:keyIdDeletes a usage plan key and remove the underlying API key from the associated usage plan.
  • GETGet vpc link/vpclinks/:vpcLinkIdGets a specified VPC link under the caller's account in a region.
  • DELETEDelete vpc link/vpclinks/:vpcLinkIdDeletes an existing VpcLink of a specified identifier.
  • PATCHUpdate vpc link/vpclinks/:vpcLinkIdUpdates an existing VpcLink of a specified identifier.
  • DELETEFlush stage authorizers cache/restapis/:restApiId/stages/:stageName/cache/authorizersFlushes all authorizer cache entries on a stage.
  • DELETEFlush stage cache/restapis/:restApiId/stages/:stageName/cache/dataFlushes a stage's cache.
  • GETGet client certificates/clientcertificates?position=string&limit=0Gets a collection of ClientCertificate resources.
  • POSTGenerate client certificate/clientcertificatesGenerates a ClientCertificate resource.
  • GETGet account/accountGets information about the current Account resource.
  • PATCHUpdate account/accountChanges information about the current Account resource.
  • GETGet export/restapis/:restApiId/stages/:stageName/exports/:exportTypeExports a deployed version of a RestApi in a specified format.
  • GETGet gateway responses/restapis/:restApiId/gatewayresponses?position=string&limit=0Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API…
  • GETGet model template/restapis/:restApiId/models/:modelName/default_templateGenerates a sample mapping template that can be used to transform a payload into the structure of a model.
  • GETGet resources/restapis/:restApiId/resources?position=string&limit=0&embed=Lists information about a collection of Resource resources.
  • GETGet sdk/restapis/:restApiId/stages/:stageName/sdks/:sdkTypeGenerates a client SDK for a RestApi and Stage.
  • GETGet sdk type/sdktypes/:idGets an SDK type.
  • GETGet sdk types/sdktypes?position=string&limit=0Gets SDK types
  • GETGet tags/tags/:resourceArn?position=string&limit=0Gets the Tags collection for a given resource.
  • PUTTag resource/tags/:resourceArnAdds or updates a tag on a given resource.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes a tag from a given resource.
  • GETGet usage/usageplans/:usagePlanId/usage?keyId=string&startDate=string&endDate=string&position=string&limit=0Gets the usage data of a usage plan in a specified time interval.
  • POSTReject domain name access association/rejectdomainnameaccessassociations?domainNameAccessAssociationArn=string&domainNameArn=stringRejects a domain name access association with a private custom domain name. To reject a domain name access association with an access association source in…
  • PATCHUpdate usage/usageplans/:usagePlanId/keys/:keyId/usageGrants a temporary extension to the remaining quota of a usage plan associated with a specified API key.

API details

Base URL
https://apigateway.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
122 operations on 53 pathsGET 47DELETE 25PATCH 22POST 20PUT 8
Description format
AWS Smithy model, API version 2015-07-09

How to test the Amazon API Gateway in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon API Gateway collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get api keys” (GET /apikeys?position=string&limit=0&name=string&customerId=string&includeValues=true), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon API Gateway?

Amazon API Gateway Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows… It is listed under Developer tools and has 122 endpoints.

Who publishes the Amazon API Gateway?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon API Gateway?

Requests go to https://apigateway.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon API Gateway?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon API Gateway have?

122 operations on 53 paths (47 GET, 25 DELETE, 22 PATCH, 20 POST, 8 PUT).

Is forking the Amazon API Gateway free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.