Get maintenance window details. | Kibana API documentation

Get maintenance window details. Generally available; added in 9.1.0

GET /api/maintenance_window/{id}

Api key auth Basic auth

Spaces method and path for this operation:

get /s/{space_id}/api/maintenance_window/{id}

Refer to Spaces for more information.

[Required authorization] Route required privileges: read-maintenance-window.

Path parameters

id string Required

The identifier for the maintenance window.

Responses

200 application/json

Indicates a successful call.
Hide response attributes Show response attributes object
- created_at string Required
  
  The date and time when the maintenance window was created.
- created_by string | null
  
  The identifier for the user that created the maintenance window.
- enabled boolean Required
  
  Whether the current maintenance window is enabled. Disabled maintenance windows do not suppress notifications.
- id string Required
  
  The identifier for the maintenance window.
- schedule object Required
  
  Additional properties are NOT allowed.
  
  Hide schedule attribute Show schedule attribute object
  
  custom object Required
  
  Additional properties are NOT allowed.
  
  Hide custom attributes Show custom attributes object
  
  duration string Required
  
  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.
  
  recurring object
  
  Additional properties are NOT allowed.
  
  Hide recurring attributes Show recurring attributes object
  
  end string
  
  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.
  
  every string
  
  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.
  
  occurrences number
  
  The total number of recurrences of the schedule.
  
  onMonth array[number]
  
  The specific months for a recurring schedule. Valid values are 1-12.
  
  Not more than 12 elements.
  
  onMonthDay array[number]
  
  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.
  
  Not more than 31 elements.
  
  onWeekDay array[string]
  
  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.
  
  Not more than 77 elements. Maximum length of each is 10.
  
  start string Required
  
  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.
  
  timezone string
  
  The timezone of the schedule. The default timezone is UTC.
- scope object
  
  Additional properties are NOT allowed.
  
  Hide scope attributes Show scope attributes object
  
  alerting object Required
  
  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.
  
  Additional properties are NOT allowed.
  
  Hide alerting attributes Show alerting attributes object
  
  enabled boolean
  
  Whether this maintenance window applies to Alerting V1 alerts. If omitted, is treated as true.
  
  query object Required
  
  Additional properties are NOT allowed.
  
  Hide query attribute Show query attribute object
  
  kql string Required
  
  A filter written in Kibana Query Language (KQL). Only alerts matching this query will be suppressed by the maintenance window.
  
  alerting_v2 object
  
  Settings that control how this maintenance window affects Alerting V2 alerting episodes, including an optional KQL filter. If you omit alerting_v2, the maintenance window doesn't affect Alerting V2 alert episodes.
  
  Additional properties are NOT allowed.
  
  Hide alerting_v2 attributes Show alerting_v2 attributes object
  
  enabled boolean
  
  Whether the maintenance window applies to Alerting V2 alert episodes. If omitted, is treated as true.
  
  query object
  
  Additional properties are NOT allowed.
  
  Hide query attribute Show query attribute object
  
  kql string Required
  
  A KQL filter that limits which Alerting V2 alert episodes this maintenance window affects. Matching alert episodes don't send notifications while the window is active. If query isn't returned, the window affects all Alerting V2 alert episodes.
  
  Maximum length is 4096.
- status string Required
  
  The current status of the maintenance window.
  
  Values are running, upcoming, finished, archived, or disabled.
- title string Required
  
  The name of the maintenance window.
- updated_at string Required
  
  The date and time when the maintenance window was last updated.
- updated_by string | null
  
  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.

GET /api/maintenance_window/{id}

curl \
 --request GET 'https://localhost:5601/api/maintenance_window/{id}' \
 --header "Authorization: $API_KEY"

Response examples (200)

The response returned when a maintenance window is successfully retrieved.

{
  "created_at": "2025-02-25T10:00:00.000Z",
  "created_by": "elastic",
  "enabled": true,
  "id": "f0cb1780-537a-4e34-8adf-3b4336862858",
  "schedule": {
    "custom": {
      "duration": "2h",
      "recurring": {
        "every": "1w",
        "occurrences": 10,
        "onWeekDay": [
          "MO",
          "WE"
        ]
      },
      "start": "2025-03-01T08:00:00.000Z",
      "timezone": "Europe/Amsterdam"
    }
  },
  "scope": {
    "alerting": {
      "query": {
        "kql": "kibana.alert.tags: \"infra\""
      }
    }
  },
  "status": "upcoming",
  "title": "Weekly Maintenance Window",
  "updated_at": "2025-02-25T10:00:00.000Z",
  "updated_by": "elastic"
}