Skip to main content
POST
Error
Back to the Project deployment APIs overview Use this endpoint to deploy a 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 not ready.
  • 409 QUALIFICATION_GATE_FAILED: The release failed the qualification gate.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

projectId
string
required

UUID v7; must be in the key/token's projectIds.

Body

application/json
releaseId
string
required

The ready release to deploy.

Minimum string length: 1
environment
enum<string>
required
Available options:
dev,
staging,
production
bypassQualificationGate
boolean

Requires scope cicd.gate.bypass.

bypassReason
string

Required audit reason when bypassing.

Response

Deploy started

success
boolean
required
deploymentId
string
required

Id of the (new) deployment this action created.

jobId
string
required

cicd-deploy-<deploymentId>.

statusUrl
string
jobStatusUrl
string