Skip to content
Install

Replace a job's entire ordered step list

PUT
/jobs/{id}/steps
curl --request PUT \
--url https://example.com/jobs/example/steps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "steps": [ { "command": "example", "cpuRequestMilli": 1, "deploymentId": "example", "envVars": [ { "key": "example", "value": "example" } ], "image": "example", "memoryRequestBytes": "example", "name": "example", "retries": 1, "script": "example", "scriptRuntime": "bash", "timeoutSeconds": 1, "type": "script" } ] }'

Auth: authenticated

id
required
string
Media typeapplication/json
object
steps
required

The new ordered step list

Array<object>
>= 1 items <= 10 items
object
command

Shell command; required for app steps, optional for image steps (defaults to the image entrypoint)

string
cpuRequestMilli

CPU request in millicores

integer
>= 50 <= 8000
deploymentId

Deployment UUID (app type, must belong to the same project)

string
envVars

Environment variables (for app steps these override the deployment env)

Array<object>
object
key
required
string
value
required
string
image

Container image reference (image type)

string
memoryRequestBytes

Memory request in bytes

Any of:
string
name

Step display name

string
<= 255 characters
retries

Retries on failure (default 0)

integer
<= 3
script

Script source (script type)

string
<= 65536 characters
scriptRuntime

Script runtime (script type)

string
Allowed values: bash python node
timeoutSeconds

Per-step timeout (default 1800)

integer
>= 30 <= 21600
type
required

Script = inline script in a curated runtime; app = command in an existing deployment’s image+env; image = arbitrary container image

string
Allowed values: script app image
key
additional properties
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"
}
]
}