Amazon API Gateway
Developer Guide

Change a Public or Private API Endpoint Type in API Gateway

Changing an API endpoint type requires you to update the API's configuration. You can change an existing API type using the API Gateway console, AWS CLI, an AWS SDK for API Gateway, or the API Gateway REST API. The update operation may take up to 60 seconds to complete, during which your API will not be available.

The following endpoint type changes are supported:

  • From edge-optimized to regional or private

  • From regional to edge-optimized or private

  • From private to regional

You cannot change a private API into an edge-optimized API.

If you are changing a public API from edge-optimized to regional or vice versa, note that an edge-optimized API may have different behaviors than a regional API. For example, an edge-optimized API removes the Content-MD5 header. Any MD5 hash value passed to the backend can be expressed in a request string parameter or a body property. However, the regional API passes this header through, although it may remap the header name to some other name. Understanding the differences helps you decide how to update an edge-optimized API to a regional one or from a regional API to an edge-optimized one.

Use the API Gateway Console to Change an API Endpoint Type

To change the API endpoint type of your API, perform one of the following sets of steps:

To convert a public endpoint from regional or edge-optimized and vice versa

  1. Sign in to the API Gateway console and choose APIs in the primary navigation pane.

  2. Choose the settings (gear icon) of an API under + Create API.

  3. Change the Endpoint Type option under Endpoint Configuration from Edge Optimized to Regional or from Regional to Edge Optimized.

  4. Choose Save to start the update.

To convert a private endpoint to a regional endpoint

  1. Sign in to the API Gateway console and choose APIs in the primary navigation pane.

  2. Choose the settings (gear icon) of an API under + Create API.

  3. Edit the resource policy for your API to remove any mention of VPCs or VPC endpoints so that API calls from outside your VPC as well as inside your VPC will succeed.

  4. Change the Endpoint Type to Regional.

  5. Choose Save to start the update.

  6. Remove the resource policy from your API.

  7. Redeploy your API so that the changes will take effect.

Use the AWS CLI to Change an API Endpoint Type

To use the AWS CLI commands to update an edge-optimized API of {api-id}, call the restapi:update as follows:

aws apigateway update-rest-api \ --rest-api-id {api-id} --patch-operations op=replace,path=/endpointConfiguration/types/EDGE,value=REGIONAL

The successful response has a status code of 200 OK and a payload similar to the following:

{ "createdDate": "2017-10-16T04:09:31Z", "description": "Your first API with Amazon API Gateway. This is a sample API that integrates via HTTP with our demo Pet Store endpoints", "endpointConfiguration": { "types": "REGIONAL" }, "id": "0gsnjtjck8", "name": "PetStore imported as edge-optimized" }

Conversely, update a regional API to an edge-optimized API as follows:

aws apigateway update-rest-api \ --rest-api-id {api-id} --patch-operations op=replace,path=/endpointConfiguration/types/REGIONAL,value=EDGE

Because put-rest-api is for updating API definitions, it is not applicable to updating an API endpoint type.

Use the API Gateway REST API to Change an API Endpoint Type

To use the API Gateway REST API to update an edge-optimized API of {api-id}, call the restapi:update as follows:

PATCH /restapis/{api-id} { "patchOperations" : [{ "op" : "replace", "path" : "/endpointConfiguration/types/EDGE", "value" : "REGIONAL" }] }

The successful response has a status code of 200 OK and a payload similar to the following:

{ "createdDate": "2017-10-16T04:09:31Z", "description": "Your first API with Amazon API Gateway. This is a sample API that integrates via HTTP with our demo Pet Store endpoints", "endpointConfiguration": { "types": "REGIONAL" }, "id": "0gsnjtjck8", "name": "PetStore imported as edge-optimized" }

Conversely, to update a regional API to an edge-optimized API, call the restapi:update as follows:

PATCH /restapis/{api-id} { "patchOperations" : [{ "op" : "replace", "path" : "/endpointConfiguration/types/REGIONAL", "value" : "EDGE" }] }

Because restapi:put is for updating API definitions, it is not applicable to updating an API endpoint type.