Skip to content
Install

Trigger a job run now (409 if a run is active and the policy is forbid)

POST
/jobs/{id}/runs
curl --request POST \
--url https://example.com/jobs/example/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "allowConcurrent": true }'

Auth: authenticated

id
required
string
Media typeapplication/json
object
allowConcurrent

Start even if another run is active

boolean
key
additional properties

Example generated

{
"allowConcurrent": true
}

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"
}