Skip to Content
ReferenceAPI referenceSystem

List the scheduler jobs

GET
/api/v1/system/scheduler/jobs

Returns every scheduled job with its trigger, its next run and the outcome of its last run since this process started.

Authorization

cookiesession<token>

Session cookie authentication.

Response Body

Request fulfilled, document follows

application/json
  1. response

The scheduler and its jobs.

jobs*array<>
schedulerEnabled*boolean

Whether the scheduler is turned on in this process. False with SCHEDULER_ENABLED=false and whenever the process has no scheduler, such as after a start without the database.

schedulerRunning*boolean
status?string

disabled with SCHEDULER_ENABLED=false. unavailable when the app started without its database and has no scheduler.

Default"running"
Value in"running""disabled""unavailable"
Example Request
curl -X GET 'https://geometrikks.example.com/api/v1/system/scheduler/jobs'
Example Response200
{  "jobs": [    {      "id": "string",      "lastDurationSeconds": 0,      "lastError": "string",      "lastRunTime": "2019-08-24T14:15:22Z",      "lastStatus": "success",      "name": "string",      "nextRunTime": "2019-08-24T14:15:22Z",      "running": true,      "trigger": "string"    }  ],  "schedulerEnabled": true,  "schedulerRunning": true,  "status": "running"}

Get the newest release above the running version GET

Reports the last check against GitHub Releases. `status` is `off` with APP_UPDATE_CHECK=false, with SCHEDULER_ENABLED=false, on agents and on local builds. This endpoint never calls GitHub itself.

Run a scheduler job now POST

Moves the job's next run to now and answers 202 right away, before the job finishes. A job that is already running does not start a second time, and an interval job counts its next run from this one. An unknown job id gets a 404, and so does every id while this process has no scheduler. Needs a Read/write API key or a browser session.