maintenance

POST /api/v1/maintenance/schedules/

Create a new maintenance schedule

Schedule types

The schedule_type field determines the maintenance behavior and which other fields are required:

  • RRULE — Recurring window. Requires rrule (a valid RFC 5545 RRULE string) and duration_minutes. starts_at anchors the recurrence and takes priority over the RRULE DTSTART; ends_at optionally bounds when the recurrence stops.
  • ONE_OFF — Single window. Requires starts_at plus either ends_at or duration_minutes (when only duration_minutes is given, ends_at is derived from starts_at). rrule must not be set.
  • MANUAL — Indefinite/open-ended window. Requires starts_at; omit ends_at to keep the window ongoing. rrule and duration_minutes are not used. Manual schedules are normally created by the per-check "maintenance now" toggle; deleting one ends the manual maintenance for its checks.

Request

Request body

namestring
schedule_type'RRULE' | 'MANUAL' | 'ONE_OFF' required
starts_atstring date-time required
ends_atstring date-time nullable
rrulestring
duration_minutesinteger nullable
is_activeboolean
pause_checks_during_maintenanceboolean
servicesinteger[]
tagsinteger[]

Response

idinteger
namestring
schedule_type'RRULE' | 'MANUAL' | 'ONE_OFF'
starts_atstring date-time
ends_atstring date-time nullable
rrulestring
duration_minutesinteger nullable
is_activeboolean
pause_checks_during_maintenanceboolean
servicesstring
created_atstring date-time
modified_atstring date-time

Changes

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