Undeploying an API proxy

This page applies to Apigee and Apigee hybrid.

View Apigee Edge documentation.

Undeploy an API proxy revision from your cluster as described in the following sections.

Note that when you undeploy a revision:

Apigee does not roll the revision back to the previously deployed revision.
After undeploying, no revisions of the API proxy are deployed in the environment.

Undeploying an API proxy is similar to deleting an API proxy, except that when you undeploy a revision you can choose to edit it in the UI and later re-deploy it. If you delete the API proxy, it is no longer available to edit.

Apigee UI

To undeploy an API proxy using the UI:

In the Google Cloud console, go to the Apigee > Proxy Development > API Proxies page.

Go to API Proxies
Select the API proxy that you want to undeploy. The UI displays the API proxy's Overview view.
In the Deployments section, click Undeploy.
In the Undeploy dialog, click Confirm.

Apigee API

To undeploy an API proxy, use the following API call:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/apis/$API/revisions/$REV/deployments" \
  -X DELETE \
  -H "Authorization: Bearer $TOKEN"

Where $TOKEN is set to your OAuth 2.0 access token, as described in Obtaining an OAuth 2.0 access token. For information about the curl options used in this example, see Using curl. For a description of environment variables you can use, see Setting environment variables for Apigee API requests.

The following provides an example of the response output (an empty response):

{}

For more information, see the Undeploy API proxy revision API.

gcloud

The following sections provide examples of using gcloud alpha apigee CLI commands to undeploy API proxy revisions and validate the undeployment.

For more information and a description of the environment variables used in the examples, see Getting started using gcloud with Apigee.

Undeploying an API proxy revision using the gcloud CLI

To undeploy an API proxy revision, use the following gcloud command:

gcloud alpha apigee apis undeploy $REV --api=$API --environment=$ENV

The following provides an example of the response:

Using Apigee organization `my-org`

Validating the undeployment of an API proxy revision using the gcloud CLI

To validate that the API proxy revision has been undeployed from the environment, use the following gcloud command:

gcloud alpha apigee deployments list --api=$API --environment=$ENV