Skip to content

Amazon API Gateway API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<fullname>Amazon API Gateway</fullname> <p>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.</p>

Amazon API Gateway is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 120 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2015-07-09
Endpoints
120
Spec updated
2020-05-04

Endpoints

MethodPathWhat it does
GET/apikeysGets information about the current ApiKeys resource.
POST/apikeysCreate an ApiKey resource.
GET/restapis/{restapi_id}/authorizersDescribe an existing Authorizers resource.
POST/restapis/{restapi_id}/authorizersAdds a new Authorizer resource to an existing RestApi resource.
GET/domainnames/{domain_name}/basepathmappingsRepresents a collection of BasePathMapping resources.
POST/domainnames/{domain_name}/basepathmappingsCreates a new BasePathMapping resource.
GET/restapis/{restapi_id}/deploymentsGets information about a Deployments collection.
POST/restapis/{restapi_id}/deploymentsCreates a Deployment resource, which makes a specified RestApi callable over the internet.
GET/restapis/{restapi_id}/documentation/partsGets documentation parts.
POST/restapis/{restapi_id}/documentation/partsCreates a documentation part.
PUT/restapis/{restapi_id}/documentation/partsImports documentation parts
GET/restapis/{restapi_id}/documentation/versionsGets documentation versions.
POST/restapis/{restapi_id}/documentation/versionsCreates a documentation version
GET/domainnamesRepresents a collection of DomainName resources.
POST/domainnamesCreates a new domain name.
GET/restapis/{restapi_id}/modelsDescribes existing Models defined for a RestApi resource.
POST/restapis/{restapi_id}/modelsAdds a new Model resource to an existing RestApi resource.
GET/restapis/{restapi_id}/requestvalidatorsGets the RequestValidators collection of a given RestApi.
POST/restapis/{restapi_id}/requestvalidatorsCreates a RequestValidator of a given RestApi.
POST/restapis/{restapi_id}/resources/{parent_id}Creates a Resource resource.
GET/restapisLists the RestApis resources for your collection.
POST/restapisCreates a new RestApi resource.
GET/restapis/{restapi_id}/stagesGets information about one or more Stage resources.
POST/restapis/{restapi_id}/stagesCreates a new Stage resource that references a pre-existing Deployment for the API.
GET/usageplansGets all the usage plans of the caller's account.
POST/usageplansCreates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
GET/usageplans/{usageplanId}/keysGets all the usage plan keys representing the API keys added to a specified usage plan.
POST/usageplans/{usageplanId}/keysCreates a usage plan key for adding an existing API key to a usage plan.
GET/vpclinksGets the VpcLinks collection under the caller's account in a selected region.
POST/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 operat
GET/apikeys/{api_Key}Gets information about the current ApiKey resource.
PATCH/apikeys/{api_Key}Changes information about an ApiKey resource.
DELETE/apikeys/{api_Key}Deletes the ApiKey resource.
GET/restapis/{restapi_id}/authorizers/{authorizer_id}Describe an existing Authorizer resource.
POST/restapis/{restapi_id}/authorizers/{authorizer_id}Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.
PATCH/restapis/{restapi_id}/authorizers/{authorizer_id}Updates an existing Authorizer resource.
DELETE/restapis/{restapi_id}/authorizers/{authorizer_id}Deletes an existing Authorizer resource.
GET/domainnames/{domain_name}/basepathmappings/{base_path}Describe a BasePathMapping resource.
PATCH/domainnames/{domain_name}/basepathmappings/{base_path}Changes information about the BasePathMapping resource.
DELETE/domainnames/{domain_name}/basepathmappings/{base_path}Deletes the BasePathMapping resource.
GET/clientcertificates/{clientcertificate_id}Gets information about the current ClientCertificate resource.
PATCH/clientcertificates/{clientcertificate_id}Changes information about an ClientCertificate resource.
DELETE/clientcertificates/{clientcertificate_id}Deletes the ClientCertificate resource.
GET/restapis/{restapi_id}/deployments/{deployment_id}Gets information about a Deployment resource.
PATCH/restapis/{restapi_id}/deployments/{deployment_id}Changes information about a Deployment resource.
DELETE/restapis/{restapi_id}/deployments/{deployment_id}Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
GET/restapis/{restapi_id}/documentation/parts/{part_id}Gets a documentation part.
PATCH/restapis/{restapi_id}/documentation/parts/{part_id}Updates a documentation part.
DELETE/restapis/{restapi_id}/documentation/parts/{part_id}Deletes a documentation part
GET/restapis/{restapi_id}/documentation/versions/{doc_version}Gets a documentation version.
PATCH/restapis/{restapi_id}/documentation/versions/{doc_version}Updates a documentation version.
DELETE/restapis/{restapi_id}/documentation/versions/{doc_version}Deletes a documentation version.
GET/domainnames/{domain_name}Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
PATCH/domainnames/{domain_name}Changes information about the DomainName resource.
DELETE/domainnames/{domain_name}Deletes the DomainName resource.
GET/restapis/{restapi_id}/gatewayresponses/{response_type}Gets a GatewayResponse of a specified response type on the given RestApi.
PUT/restapis/{restapi_id}/gatewayresponses/{response_type}Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
PATCH/restapis/{restapi_id}/gatewayresponses/{response_type}Updates a GatewayResponse of a specified response type on the given RestApi.
DELETE/restapis/{restapi_id}/gatewayresponses/{response_type}Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
GET/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integrationGet the integration settings.
PUT/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integrationSets up a method's integration.
PATCH/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integrationRepresents an update integration.
DELETE/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integrationRepresents a delete integration.
GET/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}Represents a get integration response.
PUT/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}Represents a put integration.
PATCH/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}Represents an update integration response.
DELETE/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}Represents a delete integration response.
GET/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}Describe an existing Method resource.
POST/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
PUT/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}Add a method to an existing Resource resource.
PATCH/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}Updates an existing Method resource.
DELETE/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}Deletes an existing Method resource.
GET/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}Describes a MethodResponse resource.
PUT/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}Adds a MethodResponse to an existing Method resource.
PATCH/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}Updates an existing MethodResponse resource.
DELETE/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}Deletes an existing MethodResponse resource.
GET/restapis/{restapi_id}/models/{model_name}Describes an existing model defined for a RestApi resource.
PATCH/restapis/{restapi_id}/models/{model_name}Changes information about a model.
DELETE/restapis/{restapi_id}/models/{model_name}Deletes a model.
GET/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}Gets a RequestValidator of a given RestApi.
PATCH/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}Updates a RequestValidator of a given RestApi.
DELETE/restapis/{restapi_id}/requestvalidators/{requestvalidator_id}Deletes a RequestValidator of a given RestApi.
GET/restapis/{restapi_id}/resources/{resource_id}Lists information about a resource.
PATCH/restapis/{restapi_id}/resources/{resource_id}Changes information about a Resource resource.
DELETE/restapis/{restapi_id}/resources/{resource_id}Deletes a Resource resource.
GET/restapis/{restapi_id}Lists the RestApi resource in the collection.
PUT/restapis/{restapi_id}A 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 the
PATCH/restapis/{restapi_id}Changes information about the specified API.
DELETE/restapis/{restapi_id}Deletes the specified API.
GET/restapis/{restapi_id}/stages/{stage_name}Gets information about a Stage resource.
PATCH/restapis/{restapi_id}/stages/{stage_name}Changes information about a Stage resource.
DELETE/restapis/{restapi_id}/stages/{stage_name}Deletes a Stage resource.
GET/usageplans/{usageplanId}Gets a usage plan of a given plan identifier.
PATCH/usageplans/{usageplanId}Updates a usage plan of a given plan Id.
DELETE/usageplans/{usageplanId}Deletes a usage plan of a given plan Id.
GET/usageplans/{usageplanId}/keys/{keyId}Gets a usage plan key of a given key identifier.
DELETE/usageplans/{usageplanId}/keys/{keyId}Deletes a usage plan key and remove the underlying API key from the associated usage plan.
GET/vpclinks/{vpclink_id}Gets a specified VPC link under the caller's account in a region.
PATCH/vpclinks/{vpclink_id}Updates an existing VpcLink of a specified identifier.
DELETE/vpclinks/{vpclink_id}Deletes an existing VpcLink of a specified identifier.

Showing the first 100 of 120 endpoints; the full list is in the documentation.

Questions

Does the Amazon API Gateway API need an API key?

Yes. The Amazon API Gateway API uses API key authentication; the documentation explains how to get credentials.

Does the Amazon API Gateway API support HTTPS?

Yes, the Amazon API Gateway API is served over HTTPS.

How many endpoints does the Amazon API Gateway API have?

Its OpenAPI description lists 120 endpoints in version 2015-07-09. The first 100 are shown on this page.

What are alternatives to the Amazon API Gateway API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).