Help Topics

Get a Job by Name
Looks up one job by its exact name and hands back its id, without having to list every job and filter yourself. Job names are unique among active jobs, so t...
Thu, Sep 17, 2026 at 1:24 PM
Get a Job
Returns the full detail for one job -- its steps, dependencies, tags, and settings -- not just the summary row you get from List Jobs. This is the richest s...
Thu, Sep 17, 2026 at 1:24 PM
Create a Job
Creates a new job. This only creates the job's identity and a first (empty) draft version -- add steps to it separately. Having trouble reaching the...
Thu, Sep 17, 2026 at 1:24 PM
Set a Job Active or Inactive
Turns a job on or off without deleting it -- an inactive job stays fully configured but won't run (scheduled triggers skip it; Run a Job still works if ...
Thu, Sep 17, 2026 at 1:25 PM
Update a Job's Contact Info
Sets who to reach if this job needs to be stopped or is causing a problem -- name, email, phone. All three fields are optional; send null for any you want c...
Thu, Sep 17, 2026 at 1:25 PM
Promote a Job to Global
Turns a normal job into a global job -- one shared out to other fleet members, who each get their own subscribed copy. This installation becomes the master ...
Thu, Sep 17, 2026 at 1:24 PM
Move a Job to a Folder
Moves a job into a different folder, or to the root (no folder) by passing null. Having trouble reaching the API, or logging in from another machine? Se...
Thu, Sep 17, 2026 at 1:24 PM
Rename a Job / Change Its Description
Updates a job's name and description. There's one wrinkle if the job is a global job (shared to other fleet members) and this installation isn't...
Thu, Sep 17, 2026 at 1:25 PM
Delete a Job
Moves a job to the trash. Nothing is actually destroyed -- its run history is preserved, and its name is freed up for reuse. See Restore a Job to bring it b...
Thu, Sep 17, 2026 at 1:24 PM
List Deleted Jobs
Returns everything currently sitting in the trash -- jobs removed with Delete a Job but not yet restored or purged. Having trouble reaching the API, or ...
Thu, Sep 17, 2026 at 1:24 PM