List scheduled jobs

GET

/api/v1/cron

const url = 'http://localhost:11044/api/v1/cron';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

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:11044/api/v1/cron \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Returns all active cron jobs for the authenticated user’s world.

Authorizations

apiKeyAuth
basicAuth

Responses

200

List of cron jobs

*/*

Array<object>

A scheduled job in the user’s world that runs a world action on a cron schedule. GET /cron lists the active ones; POST /cron takes one to create or replace.

object

actionName

required

World action the job runs when it fires. A job saved with this blank is not scheduled again when the world’s cron configs are reloaded.

string

cron

required

Spring 6-field cron expression (seconds minutes hours day-of-month month day-of-week), e.g. 0 0 9 * * *. An unparseable expression is saved but never fires.

string

description

required

What the job does, in prose; carried on the cron event the action receives

string

name

required

Job key, unique within the user’s world: saved as config/cron/.yml, and saving a job under an existing name replaces it

string

payload

required

Values handed to the action on the cron event at every firing; empty by default

object

key

additional properties

zone

IANA zone the cron expression is read in, e.g. Australia/Sydney. Null means the owning user’s own zone; an invalid zone is logged and the user’s zone used instead.

string