Read a platform build request

import requests

url = "https://platform.ankra.app/api/v1/org/applications/{application_id}/builds/requests/{request_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://platform.ankra.app/api/v1/org/applications/{application_id}/builds/requests/{request_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "request_id": "<string>",
  "component": "<string>",
  "head_sha": "<string>",
  "ref": "<string>",
  "reason": "<string>",
  "status": "<string>",
  "build_id": "<string>",
  "claimed_at": "<string>",
  "created_at": "<string>"
}

{
  "detail": "<string>"
}

applications

Read a platform build request

Read one queued build request. Queueing a build answers with a request id before there is a build to read - the build row is created when the scheduler claims the request - so this is how a caller follows that gap: status is pending until the claim, and build_id names the build from then on. Answers 404 for every organisation without the platform_builds flag. Bearer PAT authentication (Authorization: Bearer <token>), with the organisation selected by the token or the X-Ankra-Organisation-Id override.

GET

api

org

applications

{application_id}

builds

requests

{request_id}

Read a platform build request

import requests

url = "https://platform.ankra.app/api/v1/org/applications/{application_id}/builds/requests/{request_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://platform.ankra.app/api/v1/org/applications/{application_id}/builds/requests/{request_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "request_id": "<string>",
  "component": "<string>",
  "head_sha": "<string>",
  "ref": "<string>",
  "reason": "<string>",
  "status": "<string>",
  "build_id": "<string>",
  "claimed_at": "<string>",
  "created_at": "<string>"
}

{
  "detail": "<string>"
}

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

request_id

string

required

Response

Successful Response

request_id

string

required

component

string

required

head_sha

string

required

ref

string

required

reason

string

required

Why the build was asked for: first_onboard, push, retry or demo.

status

string

required

pending until the scheduler claims the request, then claimed, then done; cancelled if it was withdrawn before a builder took it.

build_id

string | null

required

The build this request was claimed into; null while the request is still pending. Read it at /org/applications/{application_id}/builds/{build_id}.

claimed_at

string | null

required

When a builder claimed the request; null while it is still pending.

created_at

string

required

API reference

Endpoints

Read a platform build request

Authorizations

Path Parameters

Response