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 resourceorganizations/{org}/environments/{env}
-
apigee.sharedflowrevisions.deploy
on the resourceorganizations/{org}/sharedflows/{sf}/revisions/{rev}
HTTP request
POST https://apigee.googleapis.com/v1/{name=organizations/*/environments/*/sharedflows/*/revisions/*}/deployments
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name
|
Required. Name of the shared flow revision to deploy in the following format: |
Query parameters
override
boolean
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.
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