Preview a maintenance schedule
preview_maintenance_windowPreview the next three occurrences of a maintenance schedule without saving, to validate a recurring schedule before creating or updating a maintenance window.
Instructions
Compute the next three occurrences, each with start and end, that a schedule would produce, without saving anything. Use it to check a recurring schedule before create_maintenance_window or update_maintenance_window; for a saved window's occurrences use get_maintenance_window. Requires a key with the write scope. An invalid schedule is a 422 with the reason. Returns an array. Example: {"dtstart": "2026-10-18T03:00:00", "duration_minutes": 60, "rrule": "FREQ=WEEKLY;BYDAY=SU", "timezone": "Europe/Berlin"}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rrule | No | Repeats the window: one iCal RRULE without the RRULE: prefix, at most 1024 characters, for example FREQ=WEEKLY;BYDAY=SU;BYHOUR=3. Hourly, minutely and secondly frequencies are refused. Omit it for a one-time window. | |
| dtstart | Yes | The first start, an ISO 8601 date-time in the wall-clock time of timezone, for example 2026-10-14T22:00:00. A UTC offset or Z is a 422. | |
| timezone | No | IANA zone name such as Europe/Berlin, at most 64 characters. The schedule repeats in it, so a weekly 03:00 stays 03:00 across daylight-saving changes. Defaults to the organization's timezone. | |
| duration_minutes | Yes | How long each occurrence lasts, 1 to 40320 minutes. |