Updating API Gateways and API Deployments


Find out how to modify API gateways and API deployments that you previously created with the API Gateway service.

Having created an API gateway, and deployed an API on the API gateway by creating an API deployment, you might decide to change either or both. For example, to change the API gateway's name or the tags applied to it, or to change an API deployment specification to add additional back ends to the API deployment.

Note that there are some properties of API gateways and API deployments for which you cannot change the original values.

You can update API gateways and API deployments using the Console, the CLI, and the API.

You can update an API deployment specification by:

using dialogs in the Console
editing a JSON file
Console
CLI
API

To update an existing API gateway or an API deployment using the Console:

In the Console, open the navigation menu and click Developer Services. Under API Management, click Gateways.
Choose a Compartment you have permission to work in.
On the Gateways page, click the name of the API gateway that you want to update (or that contains the API deployment you want to update) to show the Gateway Details page.

To update an API gateway:

Click Edit to:
Change the API gateway's name. Avoid entering confidential information.
Enable or disable the use of network security groups (NSGs) to control access to and from the API gateway, using security rules defined for the NSGs that you specify (up to a maximum of five network security groups). You can use security rules defined for NSGs instead of, or as well as, those defined for security lists. NSGs can belong to the same compartment as the API gateway, but do not have to. See Network Security Groups.
Change the TLS certificate and domain name used by the API gateway. Note that API Gateway certificate resources and Certificates service certificate resources are only shown if available in the selected compartment. See Setting Up Custom Domains and TLS Certificates.
Change response cache configuration settings. See Caching Responses to Improve Performance.
Change the Certificate Authorities (CAs) and CA bundles included in the API gateway's trust store as custom CAs and custom CA bundles (in addition to the default CA bundle). See Customizing Trust Stores for TLS Certificate Verification.
Click Move Resource to move the API gateway to a different compartment.
Click Add Tag(s) and View Tag(s) to change and view the tags applied to the API gateway.

To update an API deployment, on the Gateway Details page, select Deployments from the Resources list and click the Actions icon (three dots) beside the API deployment you want to update:

Click Edit to change the API deployment's name, or to replace the original API deployment specification. You can change the original API deployment specification by selecting one of two options:

From Scratch: Select to change API deployment specification properties using dialogs in the Console.
Upload an existing API: Select to change API deployment specification properties by uploading a replacement JSON file.

For more information about defining API deployment specifications, see Creating an API Deployment Specification. Avoid entering confidential information.

Click Move Resource to move the API deployment to a different compartment.
Click Add Tag(s) and View Tag(s) to change and view the tags applied to the API deployment.