Preview when a schedule would fire
preview_cron_schedule
Works out the next 5 times a schedule would fire, without saving anything.
Scopeconfig:readRead only
The same validation runs as on create_site_cron and update_site_cron, including the 5 minutes minimum between runs, so an invalid schedule comes back with the reason instead of a list of times. The tool tells the client to always reach for it before writing a schedule you described in words. Times are UTC.
A schedule takes a Kind and only the fields that kind uses. hourly needs Minute, daily needs Hour and Minute, weekly needs DaysOfWeek, Hour and Minute, monthly needs DayOfMonth, Hour and Minute, and cron needs Expression. See Scheduled jobs.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
projectId |
string | Yes | The site the schedule is for. Your token's access is checked against it. |
schedule |
object | Yes | When it runs, in UTC. Its fields are Kind (hourly, daily, weekly, monthly or cron), Minute (0 to 59), Hour (0 to 23), DaysOfWeek (a list of integers from 0 to 6, Sunday is 0), DayOfMonth (1 to 31) and Expression (a five field cron expression, used only when Kind is cron). Fill only the fields the Kind uses. |