List all tasks
const url = 'http://localhost:9477/api/tasks';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url http://localhost:9477/api/tasksResponses
Section titled “Responses”OK
object
A URL to the JSON Schema for this object.
List of tasks
object
A URL to the JSON Schema for this object.
For services: whether instances start at boot. False boots in the stopped state until started via API/UI. For cron tasks: false starts the schedule paused when the task is first registered, until it is resumed.
Max missed cron ticks to re-run at startup after downtime: 0 skips, 1 re-runs only the most recent, N re-runs up to the N most recent
Provenance metadata for tasks imported from a docker compose file
object
For services: service names that must be healthy before this one starts at boot — boot ordering only, not a workflow DAG
Environment variables overlaid on the task’s process env. Values are visible to authenticated operators in the API/UI; env_file values merge in beneath the inline entries.
object
What the run’s environment starts from: ‘inherit’ (the daemon’s, the default) or ‘clean’ (PATH, SHELL, HOME, USER/LOGNAME only, as crond gives a job)
Path to a dotenv file whose KEY=VALUE pairs merge into env (inline entries win). Values are visible in the API/UI like inline env.
Window between the stop signal and SIGKILL when a run is stopped, in nanoseconds; 0 means kill immediately
For services: an instance that runs at least this long counts as healthy — resets the restart counter and clears the failed-start streak; fast exits below it count toward restart_attempts, in nanoseconds; 0 means healthy immediately on start. With a health_check, the deadline for its first pass instead.
Why this task is loaded but not on the scheduler: ‘cron’ means a live system cron daemon still reads the crontab it came from and is running it, so RunWisp stands down. Manual triggers still work. Empty means RunWisp owns the schedule.
For services: number of always-running instances
Cap how far a cron task’s start may slip so tasks sharing a fire time take turns through a daemon-wide one-at-a-time gate instead of stampeding; a run starts as soon as the gate frees and slips up to this window only under contention, in nanoseconds
Retention window in nanoseconds; 0 means no cap was configured
Row-count retention cap; 0 keeps no completed runs, omitted inherits the [defaults] value (or no cap)
Whether this is a scheduled task or an always-on service
The newest run of this task that started (pending, skipped and missed runs don’t count); absent when none has.
object
A URL to the JSON Schema for this object.
User plus system CPU time of the run’s processes, in milliseconds. Shell runs only; absent when not measured.
Why a run ended. Set when status=ended.
object
Highest resident memory of the run’s process group, in bytes. Shell runs only; absent when not measured.
Run lifecycle phase
How the run was triggered
Per-run log size cap in bytes
What to do when log output exceeds log_max_size
Maximum overlapping runs allowed for this task
Maximum runs that can wait when on_overlap = queue; 0 means none wait, so a trigger that finds every slot busy is dropped as queue_full
How overlapping runs are handled
Per-execution parameters an operator may supply at manual trigger time; scheduled runs use the declared defaults
object
When choices is set, allow values outside the list
Allowed values; renders as a dropdown
Default value used by scheduled runs and pre-filled in manual forms
Help text shown under the field
Canonical parameter key (env name, positional label, or option/flag token)
How the parameter renders into the run
Whether a manual trigger must supply a value
Value type; defaults to string
When an operator paused this task’s cron schedule (POST /api/tasks/{taskName}/pause); absent when not paused. A paused task has no nextRunAt.
For services: boot start order, lowest first (name breaks ties). Start order only — not a dependency.
For services: whether and when an instance is restarted (defaults to always). Tasks re-run a failed run via retry_* instead.
For services: consecutive fast failures tolerated before the instance is marked FATAL; 0 means give up after the very first failure
Backoff curve between consecutive restarts
For services: base delay before each restart, in nanoseconds; 0 means restart instantly
Backoff curve between consecutive retries
Base delay before each retry, in nanoseconds; 0 retries with no delay
The run command as written in runwisp.toml; absent for tasks without one (container and compose tasks).
For tasks: fire once at daemon startup, in addition to any cron schedule
For run_on_start tasks: daemon fires on every daemon start, boot once per machine (or container) boot
Path to a dotenv file whose KEY=VALUE pairs are injected into the task’s process env. The path is visible in the API/UI; keys and values are not.
For services: the supervisor’s view of each instance. Absent for tasks.
object
object
0-based slot, as RUNWISP_INSTANCE_INDEX
Exit code of the instance’s latest run; absent until one has exited since the daemon started
Exits since the instance last ran healthy
Failed starts in a row since the instance last ran healthy; it gives up once this passes restartAttempts
When the instance’s current run started; absent unless running
Restarting: between an exit and the next respawn; stopped: down until started, because the service was stopped or its restart policy (never, or on_failure after a clean exit) won’t respawn it; fatal: gave up after too many failed starts and won’t respawn until started
Stopped: an operator stopped it, autostart = false and it was never started, or every instance exited cleanly and its restart policy won’t respawn it; fatal: no instance is running or respawning, and at least one gave up or exited on a failure; degraded: some instances are down
For services: true while the service is stopped (by an operator, never started because autostart = false, or every instance exited cleanly under a restart policy that won’t respawn it) and the daemon will not respawn it until it is started. Absent for running or restarting services and for tasks.
Absolute path to the shell interpreter for run scripts; defaults to /bin/sh
Where this task’s definition came from: native (hand-authored TOML), staged (imported, not yet promoted), or cron (read live from a crontab via daemon.include_cron)
Absolute path of the crontab or staging file this task’s definition was read from; empty for hand-authored TOML
Signal sent to stop a run before SIGKILL; defaults to SIGTERM
Per-run timeout in nanoseconds
IANA timezone for cron evaluation; falls back to daemon.timezone, then the daemon’s resolved system timezone
Octal file-creation mask applied to the run’s process; empty inherits the daemon’s umask
Live CPU and memory use of the task’s running shell runs; absent when none is running or measured.
object
CPU use in percent of one core (200 = two full cores)
Resident memory in bytes
Run the process as this OS user, in ‘user’ or ‘user:group’ form (name or numeric id). Empty runs as the daemon’s user; switching users needs the daemon running as root.
For tasks: send a long_running notification once when a run is still going after this long, without stopping it, in nanoseconds; 0 means no warning
Resolved working directory for the task’s process; empty inherits the daemon’s working directory. A literal “~” means the run-as user’s home, resolved at run time
Example
{ "$schema": "http://localhost:9477/schemas/TasksResponseBody.json", "items": [ { "$schema": "http://localhost:9477/schemas/TaskResponse.json", "heldBy": "cron", "kind": "task", "lastRun": { "$schema": "http://localhost:9477/schemas/Run.json", "endReason": "succeeded", "status": "pending", "triggeredBy": "cron" }, "logOnFull": "drop_new", "onOverlap": "queue", "parameters": [ { "kind": "env", "type": "string" } ], "restart": "never", "restartBackoff": "constant", "retryBackoff": "constant", "runOnStartMode": "daemon", "service": { "instances": [ { "state": "running" } ], "state": "running" }, "source": "staged", "stopSignal": "SIGTERM" } ]}default
Section titled “default”Error
object
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
object
Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
A URI reference to human-readable documentation for the error.
Example
{ "$schema": "http://localhost:9477/schemas/ErrorModel.json", "detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "about:blank"}