Skip to main content
GET
Error
Back to the Project deployment APIs overview Use this endpoint to get a deployment’s status, environment, and release. The response includes _id, releaseId, environment, status, and previousDeploymentId. Poll it after you create or promote a deployment. The status is building, active, failed, or retired. The response includes previousDeploymentId, which is the rollback target when one exists. You can promote a deployment only when its status is active. A deployment that doesn’t exist or that you can’t access returns 404.

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.

deploymentId
string
required

Response

Success

success
boolean
required
deployment
object
required