Skip to main content
POST
Promote a site's branch

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, an opaque member token, or a verified One Auth identity access token. The credential alone identifies the member and company. Member session JWTs, and portal JWTs the server minted read-only, are refused with 403 on every write.

Path Parameters

site_id
string<uuid>
required

Public id of one of the member's sites.

slug
string
required

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. Send confirm_migrations, from a 422 destructive_change_unconfirmed refusal, after the person said yes, with the refusal's bundle_id when you have it; omit both otherwise. Any other field is refused as an unknown field.

confirm_migrations
string[]

The ids of the destructive migrations the person 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.

status
integer
required

HTTP status code (mirrors the response status line).

data
object
required

What a promote put live.

meta
object
required

Envelope metadata present on every response.