Config
A job is configured through plain files under its config directory, with a handful of metadata endpoints alongside. This page lists them all.
AI assisted, human approved — novem uses AI to review and keep our documentation up to date.
Like every novem resource, a job is a folder of small files: each setting is
read with GET, set with POST (plain text body), and cleared with
DELETE. The job itself is created with PUT, renamed with PATCH and
removed with DELETE on its base path, /v1/code/jobs/<job>.
GET /v1/code/jobs lists your jobs; GET .../jobs/<job> lists a single
job's entries.
Everything under config/ controls how and when the job runs:
| Key | Values | Description |
|---|---|---|
config/type | chains (default) | The runtime. The chains runtime is the generally available one — see the note on legacy types below. |
config/chains | chain grammar | The pipeline definition — which repo images run, in what order. See chains. |
config/schedule | cron expression | Optional cron trigger, with TZ= and comment support. See schedule. |
config/enabled | true / false (default true) | Kill switch: while false, scheduled triggers are skipped (manual runs still work). |
config/env/<name> | any text | Environment variables injected into the running container. Encrypted at rest, write-only — GET config/env lists names, never values. Use lower-case names; both name and NAME are visible to your code. |
config/comments | true / false (default true) | Whether others can comment on the job (its threads). |
Example: pause a job without touching its schedule:
false
Note: Some keys are only listed (and writable) when they apply to the
job's current config/type: chains requires the chains type, while the
legacy extract / render keys require the legacy types.
The route tree also carries config/extract, config/render,
config/filter and config/group, which belong to the older single-image
data / pdf runtimes. Writing those types to config/type (and
configuring extract / render) requires the f_jobs feature flag and is
not generally available. Stick with the default chains runtime.
Alongside config/ and runs, each job
carries:
| Endpoint | Access | Description |
|---|---|---|
name | read/write | Display name. |
description | read/write | Longer free-form description. |
summary | read/write | One-line summary shown in job listings. |
status | read/write | Free-form status text — a place for your pipeline to surface its own state. |
shortname | read | The auto-generated short id (used in URLs). |
url | read | The job's canonical web URL, https://novem.io/j/<shortname>. |
notifications | read/write | Your notification level for this job's run events: ignore, info or important. Per caller — it doesn't affect other users. |
shared | read/write | Who can see the job: PUT/DELETE a group reference (+org~group, @user~group) or public under it. |
tags | read/write | Tags on the job — see tags. |
vars | read/write | Job variables — see vars. |
threads | read/write | Comment threads on the job; disable with config/comments. |