Skip to main content
POST
Start or resume an application deploy run

Authorizations

Authorization
string
header
required

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

Path Parameters

application_id
string
required

Body

application/json
cluster_id
string
required
roles
DeployRunRoleRequest · object[]
required

The queue in deploy order: platform stacks first, the application stack last.

Response

Successful Response

id
string
required
cluster_id
string
required
status
string
required

pending, running, succeeded, or failed.

message
string | null
required
resumed
boolean
required

True when the request joined a run that was already in flight instead of starting a new one.

divergence
string | null
required

How a resumed run differs from the queue the request carried (a role not in the run, a role deploying a different stack name or draft, or a differing role count). Null when the request asked for what is already in flight, and always null on a run this request started.

roles
DeployRunRole · object[]
required