Skip to main content
Get an Actions job projection

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Path Parameters

job_id
string
required

Workspace-owned BoxRouter job projection ID, not a GitHub job ID.

Required string length: 1 - 128
Pattern: ^[^\u0000]*$

Response

Latest workspace-owned job projection and linked placement IDs.

id
string
required
Required string length: 1 - 128
Pattern: ^[^\u0000]*$
run_id
string
required
Required string length: 1 - 128
Pattern: ^[^\u0000]*$
github_job_id
string
required
Required string length: 1 - 128
Pattern: ^[^\u0000]*$
name
string
required
Required string length: 1 - 255
state
enum<string>
required
Available options:
queued,
preparing,
starting,
running,
stopping,
ended,
attention_required
result
enum<string> | null
required
Available options:
success,
workload_failure,
cancelled,
timed_out,
infrastructure_failure,
skipped,
neutral,
unknown,
null
placement_ids
string[]
required
Required string length: 1 - 128
Pattern: ^[^\u0000]*$
repository
string

Durable GitHub repository full name when known.

Required string length: 1 - 255
workflow
string

GitHub workflow name when known.

Required string length: 1 - 255
job_name
string

GitHub job name when known.

Required string length: 1 - 255
job_url
string<uri>

GitHub workflow job URL when known.

Maximum string length: 2048
run_url
string<uri>

GitHub workflow run URL when known.

Maximum string length: 2048
branch
string

Head branch when known.

Required string length: 1 - 255
head_sha
string
Required string length: 1 - 128
Pattern: ^[^\u0000]*$
requested_environment
object

Frozen admitted job request values only, from jobs.request_json metadata.actions.policy.profile and requirements. These are requested values, not configured or observed allocation. Null means the value was not recorded or is invalid; no defaults or current policy are inferred.

requested_labels
string[] | null

GitHub runner labels frozen from the verified workflow job request at admission; absent or null when historical evidence is unavailable.

Required string length: 1 - 128
Pattern: ^[^\u0000]*$
failure
object
waiting
object

Why a job that has not started is still waiting. A running job can also wait, while its registered runner waits for GitHub to hand it the job (reason_code registered); its run reads starting unless another of its jobs is further along. Present only while it waits; absent otherwise and from servers that predate it. sources.waiting names the record it came from.

machine
object

What machine the job ran on and how fast it was against what is usual. Absent while the job has no recorded machine facts and from servers that predate it. typical_score and speed_ratio are null unless enough signed samples from enough workspaces stand behind the typical score.

billing
object
cost
object | null

Cost for this job, summed across its distinct Actions sandboxes. Null when no trustworthy cost evidence is available.

lifetime_seconds
integer | null
Required range: x >= 1
sources
object
sandbox
object | null

The most recent durable placement sandbox for this job, including after cleanup.

route_selection
object
creation
object

Diagnostics of the latest placement's creation; each placement carries its own.

ordered_routes
object[]

Frozen route facts in the same order as route_selection.ordered_route_ids.