Required. Name of the API proxy revision deployment in the following format: organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}
Query parameters
Parameters
sequencedRollout
boolean
Flag that specifies whether to enable sequenced rollout.
If set to true, the environment group routing rules corresponding to this deployment will be removed before removing the deployment from the runtime. This is likely to be a rare use case; it is only needed when the intended effect of undeploying this proxy is to cause the traffic it currently handles to be rerouted to some other existing proxy in the environment group.
The deployments.generateUndeployChangeReport API may be used to examine routing changes before issuing the undeployment request, and its response will indicate if a sequenced rollout is recommended for the undeployment.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-02 UTC."],[[["This endpoint undeploys an API proxy revision from a specified environment."],["To successfully undeploy, two permissions are required: `apigee.deployments.delete` on the environment and `apigee.proxyrevisions.undeploy` on the API proxy revision."],["The HTTP request uses `DELETE` method with a specific URL structure that requires organization, environment, API, and revision to be supplied as part of the `name` parameter in the path."],["A `sequencedRollout` query parameter is available to control the removal of environment group routing rules before removing the deployment, useful for traffic rerouting to another proxy."],["The request body should be empty and, upon successful undeployment, the response body will also be empty."]]],[]]
