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

Stay organized with collections Save and categorize content based on your preferences.

Deploys a revision of an API proxy.

If another revision of the same API proxy revision is currently deployed, set the override parameter to true to have this revision replace the currently deployed revision.

You cannot invoke an API proxy until it has been deployed to an environment. After you deploy an API proxy revision, you cannot edit it. To edit the API proxy, you must create and deploy a new revision.

For a request path organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}/deployments, 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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

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

Query parameters

Parameters
override

boolean

Flag that specifies whether the new deployment replaces other deployed revisions of the API proxy in the environment. Set override to true to replace other deployed revisions. By default, override is false and the deployment is rejected if other revisions of the API proxy are deployed in the environment.

sequencedRollout

boolean

Flag that specifies whether to enable sequenced rollout.

If set to true, the routing rules for this deployment and the environment changes to add the deployment will be rolled out in a safe order. This reduces the risk of downtime that could be caused by changing the environment group's routing before the new destination for the affected traffic is ready to receive it. This should only be necessary if the new deployment will be capturing traffic from another environment under a shared environment group or if traffic will be rerouted to a different environment due to a base path removal.

The deployments.generateDeployChangeReport API may be used to examine routing changes before issuing the deployment request, and its response will indicate if a sequenced rollout is recommended for the deployment.

serviceAccount

string

Google Cloud IAM service account.

The service account represents the identity of the deployed proxy, and determines what permissions it has. The format must be {ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com.

Authorization requires the following IAM permission on the specified resource serviceAccount:

  • iam.serviceAccounts.actAs

Request body

The request body must be empty.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

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