Get maintenance window details.

Base URL: https://{kibana_url}

GET /api/maintenance_window/{id}

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>

Path parameters

Responses

Indicates a successful call.

application/json

created_at string required: The date and time when the maintenance window was created.
created_by string · default: null nullable: 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
scope object
status enum required: The current status of the maintenance window.; Values: running upcoming finished archived 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 · default: null nullable: 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.

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/maintenance_window/ID

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

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: \u0022infra\u0022"
      }
    }
  },
  "status": "upcoming",
  "title": "Weekly Maintenance Window",
  "updated_at": "2025-02-25T10:00:00.000Z",
  "updated_by": "elastic"
}