Undeploying an API proxy

This pageapplies toApigee andApigee hybrid.

View Apigee Edge documentation.

Note: To undeploy API proxies in environments enabled forarchive deployments, seeDeploying and managing archives in an Apigee environment.

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 todeleting an API proxy, exceptthat when you undeploy a revision you can choose to edit it in the UI and later re-deploy it. If youdelete the API proxy, it is no longer available to edit.

Apigee UI

To undeploy an API proxy using the UI:

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

    Go to API Proxies

  2. Select the API proxy that you want to undeploy. The UI displays the API proxy'sOverview view.

  3. In theDeployments section, clickUndeploy.

    Undeploy screenshot

  4. In theUndeploy dialog, clickConfirm.

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 inObtaining an OAuth 2.0 access token. For information about thecurl options used in this example, seeUsing curl. For a description of environment variables you can use, seeSettingenvironment variables for Apigee API requests.

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

{}

For more information, see theUndeploy API proxy revision API.

gcloud

The following sections provide examples of usinggcloud 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,seeGetting 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

The following provides an example of the response:

Using Apigee organization `my-org`Listed 0 items.

For more information, seeList deployments CLI.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-19 UTC.