settings

Invoke a specific job

Invokes a specific job to run. Will return the new job status in JSON format.

post/settings/jobs/{jobId}/run

Request

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

Path parameters

jobIdstring required

Response

Invoked job 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.