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

Deploys a revision of a shared flow.

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

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

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

  • apigee.deployments.create on the resource organizations/{org}/environments/{env}
  • apigee.sharedflowrevisions.deploy on the resource organizations/{org}/sharedflows/{sf}/revisions/{rev}

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



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

Query parameters



Flag that specifies whether the new deployment replaces other deployed revisions of the shared flow 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 shared flow are deployed in the environment.

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: