settings

Get scheduled jobs

Returns list of all scheduled jobs and details about their next execution time in a JSON array.

get/settings/jobs

Request

  • Base URL: http://localhost:5055/api/v1
  • URL: http://localhost:5055/api/v1/settings/jobs
  • Auth: one of:
    • API key in cookie connect.sid
    • API key in header X-Api-Key

Response

Scheduled jobs returned

idstring
type'process' | 'command'
interval'short' | 'long' | 'fixed'
namestring
nextExecutionTimestring
runningboolean

Example response

[
  {
    "id": "job-name",
    "name": "A Job Name",
    "nextExecutionTime": "2020-09-02T05:02:23.000Z"
  }
]

Changes

No recorded changes to this operation across all 21 revisions of this API.