Replace a job's entire ordered step list
PUT
/jobs/{id}/steps
const url = 'https://example.com/jobs/example/steps';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"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"}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
Request Body
Section titled “Request Body”Media typeapplication/json
object
steps
required
The new ordered step list
Array<object>
object
command
Shell command; required for app steps, optional for image steps (defaults to the image entrypoint)
string
cpuRequestMilli
CPU request in millicores
integer
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
name
Step display name
string
retries
Retries on failure (default 0)
integer
script
Script source (script type)
string
scriptRuntime
Script runtime (script type)
string
timeoutSeconds
Per-step timeout (default 1800)
integer
type
required
Script = inline script in a curated runtime; app = command in an existing deployment’s image+env; image = arbitrary container image
string
key
additional properties
key
additional properties
Responses
Section titled “Responses”OK
Media typeapplication/json
object
concurrencyPolicy
required
string
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
trigger
required
string
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
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
name
required
string
retries
required
integer
script
required
string | null
scriptRuntime
required
string | null
stepOrder
required
integer
timeoutSeconds
required
integer
type
required
string
key
additional properties
stepSummaries
Array<object>
object
name
required
string
type
required
string
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" } ]}