Promote Deployment

POST

/apps/{app_id}/deployments/{deployment_id}/promote

• Production
• QA

Promote a built deployment to serve traffic.

409 when the state machine forbids it — a deployment cannot become deployed without having been built, and a failed one cannot be revived.

Authorizations

• BearerAuth

Parameters

Path Parameters

app_id

required

string

deployment_id

required

string

Header Parameters

X-Org-Id

Any of:

string

string

null

null

Request Body ^required

object

image_digest

required

The built image digest being promoted. Recorded so a rollback targets an artifact rather than a rebuild.

string

>= 7 characters <= 128 characters

Responses

200

Successful Response

object

data

required

object

app_id

required

string

build_finished_at

Any of:

string

string format: date-time

null

null

build_seconds

Any of:

number

number

null

null

build_started_at

Any of:

string

string format: date-time

null

null

created_at

Any of:

string

string format: date-time

null

null

deployed_at

Any of:

string

string format: date-time

null

null

deployment_id

required

string

image_digest

Any of:

string

string

null

null

last_error_sanitized

Any of:

string

string

null

null

schema_version_id

Any of:

string

string

null

null

source_ref

Any of:

string

string

null

null

status

required

string

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string