Skip to main content
POST
Queue a platform build

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
head_sha
string
required

The commit to build. The queue deduplicates on it, so a request without one has no identity.

ref
string

The branch or tag the commit came from, as a label - the build is of the commit.

component
string

The monorepo component to build; empty for the repository's single application.

reason
string

Why the platform wants this image: first_onboard, push, retry (the default), or demo.

Response

Successful Response

request_id
string
required
build_id
string | null
required

The build the live request was claimed into, when it was; null for a request still waiting.

already_requested
boolean
required

True when a live request for the same commit already existed and this call joined it instead of queueing a rival.