Skip to content
Install

Update a job's name, description, schedule, concurrency policy, or enabled state

PATCH
/jobs/{id}
curl --request PATCH \
--url https://example.com/jobs/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "concurrencyPolicy": "forbid", "description": "example", "enabled": true, "name": "example", "runTimeoutSeconds": 1, "scheduleCron": "example", "timeZone": "example" }'

Auth: authenticated

id
required
string
Media typeapplication/json
object
concurrencyPolicy
string
Allowed values: forbid allow
description
string | null
enabled

False pauses the schedule, true resumes it

boolean
name
string
<= 255 characters
runTimeoutSeconds
integer | null
>= 60 <= 21600
scheduleCron

New 5-field cron (UTC unless timeZone is set), or null to make the job manual-only

string | null
timeZone
string | null
key
additional properties

OK

Media typeapplication/json
object
concurrencyPolicy
required
string
Allowed values: forbid allow
createdAt
required
string
description
required
string | null
enabled
required
boolean
id
required
string
lastRun
required
object
createdAt
required
string
finishedAt
required
string | null
id
required
string
number
required
integer
startedAt
required
string | null
status
required
string
Allowed values: pending running succeeded failed canceled skipped timed_out
trigger
required
string
Allowed values: manual api cron
key
additional properties
name
required
string
nextRunAt
required
string | null
organizationId

Present on detail responses, absent on list responses

string
projectId
required
string
projectName
string
projectSlug
string
recentRuns
required
Array<object>
object
finishedAt
required
string | null
id
required
string
number
required
integer
startedAt
required
string | null
status
required
string
Allowed values: pending running succeeded failed canceled skipped timed_out
key
additional properties
runTimeoutSeconds
required
integer
scheduleCron
required
string | null
stepCount
integer
steps
required
Array<object>
object
command
required
string | null
cpuRequestMilli
required
integer | null
deploymentId
required
string | null
envVars
required
Array<object>
object
key
required
string
value
required
string
id
required
string
image
required
string | null
memoryRequestBytes
required
Any of:
string
name
required
string
retries
required
integer
script
required
string | null
scriptRuntime
required
string | null
Allowed values: bash python node
stepOrder
required
integer
timeoutSeconds
required
integer
type
required
string
Allowed values: script app image
key
additional properties
stepSummaries
Array<object>
object
name
required
string
type
required
string
Allowed values: script app image
key
additional properties
timeZone
required
string | null
updatedAt
required
string
key
additional properties

Example

{
"concurrencyPolicy": "forbid",
"lastRun": {
"status": "pending",
"trigger": "manual"
},
"recentRuns": [
{
"status": "pending"
}
],
"steps": [
{
"scriptRuntime": "bash",
"type": "script"
}
],
"stepSummaries": [
{
"type": "script"
}
]
}