Help Topics

Restore a Job
Brings a job back out of the trash, exactly as it was when it was deleted. Having trouble reaching the API, or logging in from another machine? See Netw...
Thu, Sep 17, 2026 at 1:24 PM
Empty the Trash
This is real, irreversible deletion. Every job currently in the trash -- and its entire run history -- is permanently destroyed. Delete a Job and Restore a ...
Thu, Sep 17, 2026 at 1:24 PM
Run a Job
Starts a job right now, the same as clicking Run in the Console. This doesn't run the job itself -- it queues the request; Worker picks it up and actual...
Thu, Sep 17, 2026 at 1:24 PM
Check a Job Run's Status
After you run a job, this is how you find out what actually happened -- Worker executes runs asynchronously, so starting one only tells you it was queued, n...
Thu, Sep 17, 2026 at 1:24 PM
Cancel a Job Run
Stops a run that's already in progress -- either a graceful stop (finish the current step, don't start the next one) or a hard stop (kill it immedia...
Thu, Sep 17, 2026 at 1:24 PM
Create a Job Step
Adds a new step to a job. Steps belong to a specific job version (a draft, before it's published), not the job directly. Having trouble reaching the...
Thu, Sep 17, 2026 at 1:25 PM
Update a Step
Updates a step's fields -- the same full save the Console's own step editor does. There's also a narrower PATCH /api/job-steps/{jobStepId} that ...
Thu, Sep 17, 2026 at 1:25 PM
List a Job's Steps
Returns every step in a job's current version. Get a Job already embeds this same list -- use this call instead when you only care about the steps and d...
Thu, Sep 17, 2026 at 1:25 PM
Set Step Dependencies
Controls which steps have to reach a certain status before another step is allowed to run. There's no "update" for an existing dependency -- t...
Thu, Sep 17, 2026 at 1:25 PM
Set a Step's Credential
Sets which stored credential a step runs as, overriding whatever the job's own default credential is. Pass null to clear the override and fall back to t...
Thu, Sep 17, 2026 at 1:25 PM