Search for a maintenance window.

Base URL: https://{kibana_url}

GET /api/maintenance_window/_find
GET /s/{space_id}/api/maintenance_window/_find

Refer to Spaces for more information.

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Query parameters

Responses

Indicates a successful call.

application/json

maintenanceWindows object[] required: The list of maintenance windows.
page number required: The current page number.
per_page number required: The number of maintenance windows returned per page.
total number required: The total number of maintenance windows that match the query.

400

Indicates an invalid schema or parameters.

403

Indicates that this call is forbidden.

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/maintenance_window/_find

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/maintenance_window/_find" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

The response returned when maintenance windows are successfully found.

{
  "maintenanceWindows": [
    {
      "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: \u0022infra\u0022"
          }
        }
      },
      "status": "upcoming",
      "title": "Weekly Maintenance Window",
      "updated_at": "2025-02-25T10:00:00.000Z",
      "updated_by": "elastic"
    },
    {
      "created_at": "2025-03-10T09:00:00.000Z",
      "created_by": "elastic",
      "enabled": true,
      "id": "a1c94560-6e3b-4ea1-9065-8e3f1b8c5f29",
      "schedule": {
        "custom": {
          "duration": "1h",
          "recurring": {
            "end": "2025-12-31T00:00:00.000Z",
            "every": "2w",
            "onWeekDay": [
              "FR"
            ]
          },
          "start": "2025-04-01T10:00:00.000Z",
          "timezone": "US/Eastern"
        }
      },
      "scope": {
        "alerting": {
          "query": {
            "kql": "kibana.alert.tags: \u0022database\u0022"
          }
        }
      },
      "status": "upcoming",
      "title": "Database Upgrade Window",
      "updated_at": "2025-03-15T14:30:00.000Z",
      "updated_by": "elastic"
    }
  ],
  "page": 1,
  "per_page": 10,
  "total": 2
}