Get daemon info

GET

/api/info

const url = 'http://localhost:9477/api/info';
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/info

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

authDisabled

required

boolean

capabilities

required

Array<object> | null

object

available

required

boolean

name

required

string

cloudEnabled

required

boolean

configLoadedAt

required

string format: date-time

configStale

required

boolean

configWarnings

Non-fatal findings in the live config, e.g. crontab jobs include_cron could not schedule. Re-derived per request, so it tracks reloads.

Array<string> | null

externalUrl

required

string

fingerprint

required

string

port

required

integer format: int64

resolvedTimezone

required

string

schedulingActive

required

boolean

serviceManaged

required

boolean

tasks

required

Array<object> | null

object

apiTrigger

required

boolean

catchUp

string

compose

object

file

required

string

projectName

required

string

service

string

cron

string

dependsOn

Array<string> | null

group

string

heldBy

Set when something other than RunWisp owns this task’s schedule, so it is listed but not fired on its cron. ‘cron’ means a live system cron daemon still reads its crontab. Manual triggers still work.

string

Allowed values: cron

instances

integer format: int64

kind

string

Allowed values: task service

maxConcurrent

integer format: int64

name

required

string

onOverlap

string

parameters

Array<object> | null

object

allow_custom

When choices is set, allow values outside the list

boolean

choices

Allowed values; renders as a dropdown

Array<string> | null

default

Default value used by scheduled runs and pre-filled in manual forms

string

description

Help text shown under the field

string

key

required

Canonical parameter key (env name, positional label, or option/flag token)

string

kind

required

How the parameter renders into the run

string

Allowed values: env arg option flag

required

Whether a manual trigger must supply a value

boolean

type

Value type; defaults to string

string

Allowed values: string number

restart

string

source

string

Allowed values: staged cron

sourceFile

string

timezoneSource

required

string

Allowed values: config system

version

required

string

Example

{
  "$schema": "http://localhost:9477/schemas/DaemonInfo.json",
  "tasks": [
    {
      "heldBy": "cron",
      "kind": "task",
      "parameters": [
        {
          "kind": "env",
          "type": "string"
        }
      ],
      "source": "staged"
    }
  ],
  "timezoneSource": "config"
}

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