Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kibana maintenance-window API

You can schedule single or recurring maintenance windows to temporarily reduce rule notifications. For example, a maintenance window prevents false alarms during planned outages.

Kibana maintenance-window API is one of 60 APIs that Kibana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include maintenance-window. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 7 operations across 5 paths. It is described by OpenAPI 3.0.3.

Requests are made against a single base URL, https://{kibana_url}.

7 operations 5 paths 0 schemas 1 DELETE2 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
Base URL
https://localhost:5601/api
Authentication
API Key, HTTP Basic
Contact
Kibana Team
Resource Areas
1

Authentication & Security 2

Kibana maintenance-window API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • apiKeyAuth — 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 base64A…

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

maintenance-window 7

You can schedule single or recurring maintenance windows to temporarily reduce rule notifications. For example, a maintenance window prevents false alarms during planned outages.

POST
/api/maintenance_window
Create a maintenance window.
post-maintenance-window 1 param body → 200400403
GET
/api/maintenance_window/_find
Search for a maintenance window.
get-maintenance-window-find 5 params → 200400403
DELETE
/api/maintenance_window/{id}
Delete a maintenance window.
delete-maintenance-window-id 2 params → 204400403404
GET
/api/maintenance_window/{id}
Get maintenance window details.
get-maintenance-window-id 1 param → 200400403404
PATCH
/api/maintenance_window/{id}
Update a maintenance window.
patch-maintenance-window-id 2 params body → 200400403404409
POST
/api/maintenance_window/{id}/_archive
Archive a maintenance window.
post-maintenance-window-id-archive 2 params → 200400403404
POST
/api/maintenance_window/{id}/_unarchive
Unarchive a maintenance window.
post-maintenance-window-id-unarchive 2 params → 200400403404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kibana-maintenance-window-api-openapi.yml Raw ↑

Other APIs Kibana publishes across the network.

Kibana Actions API
Kibana agent builder API
Kibana alerting API
Kibana APM agent configuration API
Kibana APM agent keys API
Kibana APM annotations API
Kibana APM server schema API
Kibana APM sourcemaps API
Kibana cases API
Kibana connectors API
Kibana Data streams API
Kibana data views API