Generates a report for a dry run analysis of an revisions.undeploy request without committing the undeploy.
In addition to the standard validations performed when removing deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being removed. Any potential routing conflicts or unsafe changes will be reported in the response. This routing analysis is not performed for a non-dry-run revisions.undeploy request.
For a request path organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateUndeployChangeReport, two permissions are required:
apigee.deployments.delete on the resource organizations/{org}/environments/{env}
apigee.proxyrevisions.undeploy on the resource organizations/{org}/apis/{api}/revisions/{rev}
HTTP request
POST https://apigee.googleapis.com/v1/{name=organizations/*/environments/*/apis/*/revisions/*}/deployments:generateUndeployChangeReport
[[["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-03-07 UTC."],[[["This endpoint performs a dry run analysis of an undeploy request for an API proxy revision, identifying potential traffic routing changes without actually undeploying."],["The request URL follows a specific format: `POST https://apigee.googleapis.com/v1/{name=organizations/*/environments/*/apis/*/revisions/*}/deployments:generateUndeployChangeReport`, with `name` being a path parameter detailing the API proxy revision deployment."],["Two permissions are required to execute this request: `apigee.deployments.delete` on the environment and `apigee.proxyrevisions.undeploy` on the specific API revision."],["The request body for this endpoint must be empty, and a successful response will contain a `DeploymentChangeReport`."],["The required authorization scope to call this endpoint is `https://www.googleapis.com/auth/cloud-platform`."]]],[]]
