Skip to main content
GET
Error
Back to the Project deployment APIs overview Use this endpoint to get a release and check its build status. Poll it after you create a release. Wait until the status is ready before you deploy the release. The status is one of building, validated, compiled, materializing, materializing_versions, ready, materialization_failed, failed, or superseded. The failed and materialization_failed statuses mean the build did not complete. The response includes the release source, version, and content integrity hash. The hash is set when the release is ready. It also includes a summary of the release’s deployments for each environment. A release 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.

releaseId
string
required

Response

Success

success
boolean
required
release
object
required