AuthThe Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.AvailabilityGenerally available since 9.1This functionality is generally available and ready for production usage.Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
The date and time when the maintenance window was created.
created_bystring · default: nullnullable
The identifier for the user that created the maintenance window.
enabledbooleanrequired
Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.
idstringrequired
The identifier for the maintenance window.
scheduleobjectrequired
customobjectrequired
durationstringrequired
The duration of the schedule. It allows values in <integer><unit> format. <unit> is one of d, h, m, or s for hours, minutes, seconds. For example: 1d, 5h, 30m, 5000s.
recurringobject
endstring
The end date of a recurring schedule, provided in ISO 8601 format and set to the UTC timezone. For example: 2025-04-01T00:00:00.000Z.
everystring
The interval and frequency of a recurring schedule. It allows values in <integer><unit> format. <unit> is one of d, w, M, or y for days, weeks, months, years. For example: 15d, 2w, 3m, 1y.
occurrencesnumber
The total number of recurrences of the schedule.
onMonthnumber[] · max items: 12
The specific months for a recurring schedule. Valid values are 1-12.
onMonthDaynumber[] · max items: 31
The specific days of the month for a recurring schedule. Valid values are 1 to 31, or -1 for the last day of the month.
onWeekDaystring[] · max items: 77
The specific days of the week ([MO,TU,WE,TH,FR,SA,SU]) or nth day of month ([+1MO, -3FR, +2WE, -4SA, -5SU]) for a recurring schedule.
startstringrequired
The start date and time of the schedule, provided in ISO 8601 format and set to the UTC timezone. For example: 2025-03-12T12:00:00.000Z.
timezonestring
The timezone of the schedule. The default timezone is UTC.
scopeobject
alertingobjectrequired
Settings that control how this maintenance window affects Alerting V1 alerts, including an optional KQL filter. Always returned when scope is returned. Check enabled to see whether the maintenance window affects these alerts.
enabledboolean
Whether this maintenance window applies to Alerting V1 alerts. If omitted, is treated as true.
queryobjectrequired
kqlstringrequired
A filter written in Kibana Query Language (KQL). Only alerts matching this query will be suppressed by the maintenance window.
alerting_v2object
Settings that control how this maintenance window affects Alerting V2 alerts, including an optional KQL filter. If you omit alerting_v2, the maintenance window doesn't affect Alerting V2 alerts.
enabledboolean
Whether the maintenance window applies to Alerting V2 alerts. If omitted, is treated as true.
queryobject
kqlstring · max length: 4096required
A KQL filter that limits which Alerting V2 alerts this maintenance window affects. It can filter on alert_id, alert_status, group_hash, last_event_timestamp, severity, and data.*. Matching alerts don't send notifications while the window is active. If query isn't returned, the window affects all Alerting V2 alerts.
statusenumrequired
The current status of the maintenance window.
Values:runningupcomingfinishedarchiveddisabled
titlestringrequired
The name of the maintenance window.
updated_atstringrequired
The date and time when the maintenance window was last updated.
updated_bystring · default: nullnullable
The identifier for the user that last updated this maintenance window.
400
Indicates an invalid schema or parameters.
403
Indicates that this call is forbidden.
404
Indicates a maintenance window with the given ID does not exist.