Create a maintenance window.
- Base URL
-
https://{kibana_url}
- POST /api/maintenance_window
Required authorization
- Privileges write-maintenance-window
Request body
-
enabledboolean -
Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.
-
scheduleobjectrequired -
customobjectrequired -
durationstring · max length: 100required -
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. -
recurringobject -
endstring · max length: 100 -
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 · max length: 100 -
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. -
onMonthnumber · min items: 1 · max items: 12 -
The specific months for a recurring schedule. Valid values are 1-12.
Responses
Indicates a successful call.
-
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.
-
scheduleobjectrequired -
customobjectrequired -
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. -
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 ofd,w,M, oryfor days, weeks, months, years. For example:15d,2w,3m,1y.
Indicates an invalid schema or parameters.
Indicates that this call is forbidden.