Skip to main content
GET
Check Demo Build

Authorizations

Authorization
string
header
required

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

Headers

authorization
string | null
x-ankra-organisation-id
string | null

Path Parameters

application_id
string
required

Query Parameters

branch
string
required

Response

Successful Response

Whether the branch has a built image and which tag a deploy would run. GitHub or registry problems ride in error and guidance rather than failing the request.

available_images
object[]
required

The available_tags entries in the same order, each with the push time that ranks it.

available_tags
string[]
required
branch
string
required
candidate_tags
string[]
required
component
string
required
components
object[]
required
error
string | null
required
guidance
string | null
required
head_sha
string | null
required
image_exists
boolean
required
image_tag
string | null
required
image_kind
string

Classifies what code the matched tag's image was built from: branch_head (immutable sha tag of this branch's head), merge_result (a pull_request build of the branch's open PR - the image is the branch merged into its base, not the branch head), or branch (the mutable branch tag a push build refreshes). Absent when no image matched. Mirrors the selected component's classification.

image_note
string

Human-readable caveat for a merge_result image; absent for every other kind.