Overview
Maintenance windows let you suppress alert notifications during planned work such as deployments, infrastructure upgrades, or scheduled restarts. While a maintenance window is active, alerts continue to evaluate but notifications are silenced, preventing unnecessary pages and reducing alert fatigue. You can create one-time windows for specific events or recurring windows for regular maintenance schedules.One-time windows
A one-time maintenance window covers a fixed time range defined by a start time and end time. Use these for planned deployments, migrations, or any event with a known schedule. Required fields:
Set
isRecurring to false (the default) for one-time windows.
Recurring windows
Recurring maintenance windows repeat on a defined schedule. Use these for regular maintenance periods such as weekly patching or nightly batch jobs. SetisRecurring to true and configure the duration and recurrence fields instead of specifying an endTime.
Duration
Theduration object defines how long each maintenance window lasts:
Recurrence
Therecurrence object controls how often the window repeats:
You can limit recurrence using either
untilDate or untilOccurrences. If neither is set, the window repeats indefinitely.
Managing maintenance windows
Create a maintenance window
Send aPOST request to create a new maintenance window:
List maintenance windows
Retrieve all maintenance windows for an account:Get maintenance window details
Retrieve a specific maintenance window by ID:Update a maintenance window
Modify an existing maintenance window:Delete a maintenance window
Remove a maintenance window permanently:Enable or disable a maintenance window
To temporarily disable a maintenance window without deleting it, update theenabled field to false. Set it back to true to re-enable.