Skip to main content
POST
Promote a site's branch

Authorizations

Authorization
string
header
required

A company admin credential for your company, or a droplet installation token with the website scope for reads, except on the share routes, which refuse a droplet token.

Path Parameters

id
string<uuid>
required

The site's id.

slug
string
required

The slug of one of the site's branches.

Required string length: 1 - 40
Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$

Body

application/json

The optional confirmation of a promote, sent unwrapped. Send confirm_migrations, from a 422 destructive_change_unconfirmed refusal, after the admin said yes, with the refusal's bundle_id when you have it; omit both otherwise. Any other field is refused.

confirm_migrations
string[]

The ids of the destructive migrations the admin confirmed, as the refusal's details.unconfirmed lists them.

Required array length: 1 - 100 elements
Required string length: 1 - 100
bundle_id
string<uuid>

The branch's bundle the refusal named (details.bundle_id), taken only with confirm_migrations. When the branch has published another since, the promote is refused with 409 branch_changed. Without it, the confirmation is for the bundle the branch serves now.

Response

The branch's version is live.

What a promote put live.

promotion
object
required

The live version.

status
integer
required

The HTTP status.

meta
object
required

Response metadata included on every response body.