Error
A valid request URL is required to generate request examples{
"success": true,
"deploymentId": "<string>",
"jobId": "<string>",
"statusUrl": "<string>",
"jobStatusUrl": "<string>"
}{
"error": "<string>"
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": null,
"retryable": true,
"requestId": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": null,
"retryable": true,
"requestId": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": null,
"retryable": true,
"requestId": "<string>"
}
}{
"error": "<string>"
}Promote deployment
Promote an active deployment’s release to a higher environment and run that environment’s qualification gate.
POST
/
api
/
cicd
/
v1
/
projects
/
{projectId}
/
deployments
/
{deploymentId}
/
promote
Error
A valid request URL is required to generate request examples{
"success": true,
"deploymentId": "<string>",
"jobId": "<string>",
"statusUrl": "<string>",
"jobStatusUrl": "<string>"
}{
"error": "<string>"
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": null,
"retryable": true,
"requestId": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": null,
"retryable": true,
"requestId": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": null,
"retryable": true,
"requestId": "<string>"
}
}{
"error": "<string>"
}targetEnvironment and checks that environment’s qualification gate again. The source deployment must be active. The request needs the cicd.promote scope and authority on the target environment.
Promotion creates a new deployment and runs asynchronously. The response returns deploymentId, jobId, statusUrl, and jobStatusUrl. Use the deploymentId with Get deployment to track progress. To bypass the gate, set bypassQualificationGate to true and send a bypassReason. The bypass needs the cicd.gate.bypass scope. Promotion works for projects that you import with the Import API when you build the release with source.kind set to project_snapshot.
The API returns these errors:
403 ENV_SCOPE_VIOLATION: Your key or token lacks authority fortargetEnvironment.404: The deployment doesn’t exist or you can’t access it.409 DEPLOYMENT_NOT_PROMOTABLE: The source deployment is notactive.409: The release failed the qualification gate.
Authorizations
Path Parameters
Body
application/json
Was this page helpful?