Error
A valid request URL is required to generate request examples{
"success": true,
"deploymentId": "<string>",
"jobId": "<string>",
"statusUrl": "<string>",
"jobStatusUrl": "<string>"
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": null,
"retryable": true,
"requestId": "<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>"
}
}{
"error": "<string>"
}Create deployment
Deploy a ready release to the dev, staging, or production environment of a project.
POST
/
api
/
cicd
/
v1
/
projects
/
{projectId}
/
deployments
Error
A valid request URL is required to generate request examples{
"success": true,
"deploymentId": "<string>",
"jobId": "<string>",
"statusUrl": "<string>",
"jobStatusUrl": "<string>"
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": null,
"retryable": true,
"requestId": "<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>"
}
}{
"error": "<string>"
}ready release to an environment: dev, staging, or production. Send the releaseId and the target environment. The request needs the cicd.deploy scope and authority on the target environment. Call Get caller identity to check your authority.
The deployment runs asynchronously. A deploy worker enforces the qualification gate. Poll statusUrl or jobStatusUrl to track progress. To bypass the gate, set bypassQualificationGate to true and send a bypassReason. The bypass needs the cicd.gate.bypass scope. A successful request returns 202 with deploymentId, jobId, statusUrl, and jobStatusUrl.
The API returns these errors:
403 ENV_SCOPE_VIOLATION: Your key or token lacks authority for the target environment.409 RELEASE_NOT_DEPLOYABLE: The release is notready.409 QUALIFICATION_GATE_FAILED: The release failed the qualification gate.
Authorizations
Body
application/json
Was this page helpful?