In November 2020, the Apigee Edge API reference documentation will move to a new experience based on the Apigee integrated portal and visitors to this site will be redirected.

You are viewing the Apigee Edge API reference documentation. For the main product docs, and to search all docs, go to

Force Undeploy API Proxy

Resource Summary


Content Type


API Proxy,



Force Undeploy API Proxy

Force the undeployment of the API proxy that is partially deployed. This can be necessary if the API proxy becomes partially deployed and must be undeployed, then redeployed. 

You must specify the revision number of the API proxy because multiple revisions of the same API Proxy can be deployed in the same environment if the proxy base path is different.

See Undeploy API Proxy for the standard undeploy API.

Resource URL /organizations/{org_name}/apis/{api_name}/revisions/{revision_number}/deployments

Query Parameters

Name Values Description

Specify as undeploy.


The environment of the API proxy, such as prod or test.


Specify as true to force the undeployment.

Request Body

org_name Mention the organization name true

api_name Mention the API Proxy name true

revision_number Mention the API Proxy revision number true

HTTP Basic

OAuth 2.0



Make a request and see the response.

Make a request and see the response.

Make a request and see the response.


Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)