Method: organizations.environments.apis.revisions.deployments.generateUndeployChangeReport

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Name of the API proxy revision deployment in the following format: organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of DeploymentChangeReport.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform