The date and time when the maintenance window was created.
created_bystringrequirednullable
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[]
The specific months for a recurring schedule. Valid values are 1-12.
onMonthDaynumber[]
The specific days of the month for a recurring schedule. Valid values are 1-31.
onWeekDaystring[]
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
queryobjectrequired
kqlstringrequired
A filter written in Kibana Query Language (KQL).
statusenumrequired
The current status of the maintenance window.
Values:runningupcomingfinishedarchived
titlestringrequired
The name of the maintenance window.
updated_atstringrequired
The date and time when the maintenance window was last updated.
updated_bystringrequirednullable
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.