Enable a Schedule¶

Enables a schedule so it will run on its configured trigger. Only applies to cron-triggered schedules; manual schedules can be enabled but will only run when triggered via the Run endpoint.

POST /api/v1/schedules/{id}/enable

Path Parameters¶

Parameter	Type	Description
`id`	guid	ID of the schedule

Examples¶

curlPowerShell

curl -X POST https://jim.example.com/api/v1/schedules/a1b2c3d4-e5f6-7890-abcd-ef1234567890/enable \
  -H "X-Api-Key: jim_xxxxxxxxxxxx"

Connect-JIM -Url "https://jim.example.com" -ApiKey "jim_xxxxxxxxxxxx"

Enable-JIMSchedule -Id "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response¶

Returns 200 OK with the updated Schedule object.

Errors¶

Status	Code	Description
`401`	`UNAUTHORISED`	Authentication required
`403`	`FORBIDDEN`	Insufficient permissions (Administrator role required)
`404`	`NOT_FOUND`	Schedule does not exist