List all tasks

GET

/api/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/tasks

Responses

200

application/json

array | null

object

api_trigger

required

boolean

catch_up

What to do when cron ticks are missed during downtime

string

Allowed values: latest all skip

cron

string

description

string

group

string

instances

For services: number of always-running replicas

integer format: int64

keep_for

Retention window, in nanoseconds

integer format: int64

keep_runs

integer format: int64

kind

Whether this is a scheduled task or an always-on service

string

Allowed values: task service

log_max_size

Per-task log size cap, in bytes

integer format: int64

log_on_full

What to do when log output exceeds log_max_size

string

Allowed values: drop_new drop_old kill_task

name

required

string

next_run_at

string

on_overlap

How overlapping runs are handled

string

Allowed values: queue skip terminate

parallelism

integer format: int64

restart

Whether and when a task is restarted after completion

string

Allowed values: never always on_failure

restart_backoff

Backoff curve between consecutive restarts

string

Allowed values: constant linear exponential

restart_delay

Base delay before each restart, in nanoseconds

integer format: int64

retry_attempts

integer format: int64

retry_backoff

Backoff curve between consecutive retries

string

Allowed values: constant linear exponential

retry_delay

Base delay before each retry, in nanoseconds

integer format: int64

timeout

Per-run timeout in nanoseconds

integer format: int64

timezone

IANA timezone for cron evaluation; falls back to scheduler.timezone (default UTC)

string

Example

[
  {
    "catch_up": "latest",
    "kind": "task",
    "log_on_full": "drop_new",
    "on_overlap": "queue",
    "restart": "never",
    "restart_backoff": "constant",
    "retry_backoff": "constant"
  }
]

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

array | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

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"
}