Skip to content
Install

Get a run's detail: status, trigger, timing, and per-step results

GET
/job-runs/{runId}
curl --request GET \
--url https://example.com/job-runs/example \
--header 'Authorization: Bearer <token>'

Auth: authenticated

runId
required
string

OK

Media typeapplication/json
object
createdAt
required
string
currentStepOrder
required
integer | null
errorMessage
required
string | null
finishedAt
required
string | null
id
required
string
jobId
required
string
jobName
string
number
required
integer
scheduledFor
required
string | null
startedAt
required
string | null
status
required
string
Allowed values: pending running succeeded failed canceled skipped timed_out
steps
Array<object>
object
command
string | null
exitCode
integer | null
finishedAt
string | null
id
string
logsTruncated
boolean
name
required
string
reason
string | null
resolvedImage
string | null
startedAt
string | null
status
required
string
Allowed values: pending running succeeded failed canceled skipped timed_out
stepOrder
required
integer
type
string
Allowed values: script app image
key
additional properties
trigger
required
string
Allowed values: manual api cron
triggeredBy
required
object
id
required
string
name
required
string
username
required
string
key
additional properties
key
additional properties

Example

{
"status": "pending",
"steps": [
{
"status": "pending",
"type": "script"
}
],
"trigger": "manual"
}