Create event
Create a scheduled event. Targets are resolved when it fires, not when it is saved
Authorizations
An API key from Settings, API Keys. A caller on this machine needs none.
Body
1 - 200100032ISO 8601. Defaults to now, so a dateless every event needs no date at all
1When the window closes, or null for a moment rather than a window. The event reverses itself there. A suspend resumes, a spawner stop starts. So an action with no reverse cannot have one. A time-of-day at or before starts_at crosses midnight. Not until: this is when tonight's window shuts.
1How often it repeats: 15m, 1h, 1d, 2w, 1 month. Null fires once. With no starts_at this is dateless. The anchor is snapped to the unit, so 1h means the top of every hour.
32"1d"
Weekdays it may fall on, narrowing the cadence. Weekdays-only is ["mo","tu","we","th","fr"]
mo, tu, we, th, fr, sa, su Day of the month, or -1 for its last day. The one thing starts_at cannot say, since months differ in length
-31 <= x <= 31Which match to keep. With days ["fr"] and a monthly cadence, -1 is the last Friday of the month
-53 <= x <= 53Stop repeating after this date. Null repeats forever. Not ends_at: this is when the event stops recurring at all.
The action, or use the flat shorthands below
- Option 1
- Option 2
Shorthand for action = a command
node.resume, node.finish, node.suspend, node.reserve, node.pool.change, node.restart, node.shutdown, node.wakeup, system.maintenance, system.idle, spawner.start, spawner.stop, run.script Target pool for a node.pool.change command
soft_id / version / type for a spawner command
Response
The created event
^[a-fA-F0-9]{24}$"68b1f0c2a4d3e5f6a7b8c9d0"
ISO 8601, read in the server's own zone. The only place the event's time-of-day lives
Weekdays it may fall on, narrowing the cadence. Weekdays-only is ["mo","tu","we","th","fr"]
mo, tu, we, th, fr, sa, su - Option 1
- Option 2
The commands the last fire created
When the window closes, or null for a moment rather than a window. The event reverses itself there. A suspend resumes, a spawner stop starts. So an action with no reverse cannot have one. A time-of-day at or before starts_at crosses midnight. Not until: this is when tonight's window shuts.
How often it repeats: 15m, 1h, 1d, 2w, 1 month. Null fires once. With no starts_at this is dateless. The anchor is snapped to the unit, so 1h means the top of every hour.
Day of the month, or -1 for its last day. The one thing starts_at cannot say, since months differ in length
Which match to keep. With days ["fr"] and a monthly cadence, -1 is the last Friday of the month
Stop repeating after this date. Null repeats forever. Not ends_at: this is when the event stops recurring at all.
Read-only, derived: the same recurrence as an iCalendar RRULE
The occurrence whose window is open now
Whether the last fire got its work sent. Not whether that work succeeded
ok, partial, failed, skipped, null Read-only, rolled up from those commands: what the work actually did. Null when they have aged out of the audit trail
ok, partial, failed, running, null Computed by the server. Never derive it client-side