Create a maintenance window.
https://{kibana_url}
- POST /api/maintenance_window
- POST /s/{space_id}/api/maintenance_window
Refer to Spaces for more information.
[Required authorization] Route required privileges: write-maintenance-window.
Request
-
enabledboolean -
Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.
-
scheduleobjectrequired -
custom -
durationstringrequired -
The duration of the schedule. It allows values in
<integer><unit>format.<unit>is one ofd,h,m, orsfor hours, minutes, seconds. For example:1d,5h,30m,5000s. -
recurring -
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 ofd,w,M, oryfor days, weeks, months, years. For example:15d,2w,3m,1y. -
occurrencesnumber · min: 1 -
The total number of recurrences of the schedule.
-
onMonthnumber · min: 1 -
The specific months for a recurring schedule. Valid values are 1-12.
-
onMonthDaynumber · min: 1 -
The specific days of the month for a recurring schedule. Valid values are 1-31.
-
onWeekDaystring · min: 1 -
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.
-
titlestringrequired -
The name of the maintenance window. While this name does not have to be unique, a distinctive name can help you identify a specific maintenance window.
Responses
Indicates a successful call.
-
created_atstringrequired -
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 -
custom -
durationstringrequired -
The duration of the schedule. It allows values in
<integer><unit>format.<unit>is one ofd,h,m, orsfor hours, minutes, seconds. For example:1d,5h,30m,5000s. -
recurring -
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 ofd,w,M, oryfor 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.
-
status -
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.
Indicates an invalid schema or parameters.
Indicates that this call is forbidden.