Skip to main content
Get a workflow-run projection and aggregate billing evidence

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Path Parameters

run_id
string
required

Workspace-owned BoxRouter workflow-run projection ID, not a GitHub run ID.

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

Response

Latest recorded workflow-run state and billing projection.

id
string
required
Required string length: 1 - 128
Pattern: ^[^\u0000]*$
github_run_id
string
required
Required string length: 1 - 128
Pattern: ^[^\u0000]*$
run_attempt
integer
required
Required range: x >= 1
repository_id
string
required
Required string length: 1 - 128
Pattern: ^[^\u0000]*$
workflow_name
string | null
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
created_at
string<date-time>
required
updated_at
string<date-time>
required
billing
object
required
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
branch
string

Head branch when known.

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

GitHub workflow run URL when known.

Maximum string length: 2048
head_branch
string | null
Required string length: 1 - 255
head_sha
string
Required string length: 1 - 128
Pattern: ^[^\u0000]*$
run_number
integer
Required range: x >= 1
display_title
string
Minimum string length: 1
actor
object

Original actor GitHub recorded for the workflow run. Absent when unknown.

triggering_actor
object

Actor who triggered the current run attempt

failure
object
waiting
object

The longest-waiting job of a run that has jobs waiting. Absent when none waits and from servers that predate it.

sources
object
providers
string[]

Provider IDs that ran this run's jobs, distinct, in job order. Absent when no job has been placed.

Required string length: 1 - 64
Pattern: ^[a-z][a-z0-9-]*$
started_at
string<date-time>

When the first job of this run started. Absent until one has.

completed_at
string<date-time> | null

When the last job of this run ended. Null while the run is active; absent when the run ended and no end time was confirmed.

controls
object

Optional caller-specific workflow controls for this exact attempt. Mutation routes recheck authorization and the live GitHub attempt.

cost
object | null

Sum of job costs. Null when one or more job costs are unknown; pending with a null amount when at least one job has no amount yet. Never presents a partial sum as the run total.