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

POST /api/deploy
ParameterTypeRequiredDescription
productionAppIdbodyYesProduction app to deploy to
versionIdbodyNoSpecific version to deploy (defaults to active version)
Creates a new deployment record and triggers the deployment pipeline. Authentication: Organization member + entities:deploy scope + entity publisher.

​
List deployments

GET /api/deploys
ParameterTypeDescription
productionAppIdqueryFilter by production app
statusqueryFilter by deployment status
pagequeryPage number (default: 1)
pageSizequeryItems per page (default: 20)
Authentication: User authentication required.

​
Get deployment

GET /api/deploys/{id}
Returns deployment details including status, phases, and logs. Authentication: User authentication required.

​
Cancel deployment

POST /api/deploys/{id}/cancel
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:
PhaseDescription
orchestrateInitial deployment orchestration
downloadDownload entity package
infraProvision or update infrastructure
buildBuild the application
packagePackage for deployment
migrateRun database migrations
service_deployDeploy to compute infrastructure
cache_invalidationInvalidate CDN caches
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

pending → in_progress → completed
                      → failed
                      → cancelled
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.