Turn a schedule on or off; turning it on recomputes its next run.

Turns the schedule on or off. Turning it on recomputes its next run from now and requires its script to still be approved.

post/v1/schedules/{id}/enabled

Request

  • Base URL: http://127.0.0.1:10108
  • URL: http://127.0.0.1:10108/v1/schedules/{id}/enabled
  • Auth: HTTP bearer

Path parameters

idstring required

Schedule id (uuid), as listed by GET /v1/schedules.

Request body

enabledboolean required

Response

The schedule after the change; turning it on recomputes nextRunAt from now.

concurrencyinteger required
createdAtstring date-time required
cronExprstring nullable required
dailyHourinteger nullable required
dailyMinuteinteger nullable required
enabledboolean required
headlessboolean required
idstring uuid required
intervalMinutesinteger nullable required
intervalUnit'seconds' | 'minutes' required
lastRunAtstring date-time nullable required
namestring required
nextRunAtstring date-time nullable required
profileIdsstring[] required
runAtstring date-time nullable required
scheduleType'interval' | 'daily' | 'weekly' | 'cron' | 'once' required
scriptIdstring nullable required
staggerMsinteger required
updatedAtstring date-time required
weeklyDayinteger nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.