NOTE: Some aspects of this product are in Beta. The hybrid installation options are GA. To join the Beta program, reach out to your Apigee representative.

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

Deploys a revision of a shared flow.

If a shared flow revision is currently deployed, to ensure seamless deployment with zero downtime set the override parameter to true. In this case, hybrid attempts to deploy the new revision fully before undeploying the existing revision.

You cannot use a shared flow until it has been deployed to an environment.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the shared flow revision to deploy in the following format: organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}

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.

If an existing shared flow revision is deployed, to ensure seamless deployment with no downtime, set this parameter to true. In this case, Apigee deploys the new revision fully before undeploying the existing revision. If set to false, you must undeploy the existing revision before deploying the new revision.

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