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

Generates a report for a dry run analysis of a revisions.deploy request without committing the deployment.

In addition to the standard validations performed when adding deployments, additional analysis will be done to detect possible traffic routing changes that would result from this deployment being created. 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.deploy request.

For a request path organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments:generateDeployChangeReport, two permissions are required:

  • apigee.deployments.create on the resource organizations/{org}/environments/{env}
  • apigee.proxyrevisions.deploy on the resource organizations/{org}/apis/{api}/revisions/{rev}

HTTP request

POST https://apigee.googleapis.com/v1/{name=organizations/*/environments/*/apis/*/revisions/*}/deployments:generateDeployChangeReport

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}

If the API proxy resource has the space attribute set, IAM permissions are checked differently . To learn more, read the Apigee Spaces Overview.

Query parameters

Parameters
override

boolean

Flag that specifies whether to force the deployment of the new revision over the currently deployed revision by overriding conflict checks.

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