Sign in
settings

Modify job schedule

Re-registers the job with the schedule specified. Will return the job in JSON format.

post/settings/jobs/{jobId}/schedule

Request

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

Path parameters

jobIdstring required

Request body

schedulestring

Example request

{
  "schedule": "0 */5 * * * *"
}

Response

Rescheduled job

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.