Skip to main content
Deployments represent the process of shipping an entity version to production infrastructure. Each deployment goes through multiple phases and streams real-time logs.

​
Trigger deployment

Creates a new deployment record and triggers the deployment pipeline. Authentication: Organization member + entities:deploy scope + entity publisher.

​
List deployments

Authentication: User authentication required.

​
Get deployment

Returns deployment details including status, phases, and logs. Authentication: User authentication required.

​
Cancel deployment

Cancels an in-progress deployment. The deployment pipeline receives the cancellation signal and stops processing. Authentication: Organization member + entities:deploy scope + entity publisher.

​
Deployment phases

Each deployment progresses through the following phases: Each phase has a status: pending, in_progress, completed, or failed. The platform streams real-time logs for each phase as the deployment progresses.

​
Deployment lifecycle

A deployment starts as pending, moves to in_progress when the pipeline begins processing, and ends as completed, failed, or cancelled. Failed deployments include an error message. Cancelled deployments stop the pipeline at the current phase.