Alerting enables you to define rules, which detect complex conditions within your data. When a condition is met, the rule tracks it as an alert and runs the actions that are defined in the rule. Actions typically involve the use of connectors to interact with Kibana services or third party integrations.
Kibana alerting API is one of 60 APIs that Kibana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include alerting. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes
20 operations
across 16 paths,
and defines 37 schemas.
It is described by OpenAPI 3.0.3.
Requests are made against a single base URL, https://{kibana_url}.
20 operations16 paths37 schemas3 DELETE5 GET11 POST1 PUT
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 alerting 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 20
Across 16 paths, the API surfaces 20 operations — 3 DELETE, 5 GET, 11 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
alerting 20
Alerting enables you to define rules, which detect complex conditions within your data. When a condition is met, the rule tracks it as an alert and runs the actions that are defin…
The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are Kibana_HTTP_APIs_xpack-synthetics-alerts-tls-create-rule-body-alerting (13 properties), Kibana_HTTP_APIs_index-threshold-create-rule-body-alerting (13 properties), Kibana_HTTP_APIs_observability-rules-custom-threshold-create-rule-body-alerting (13 properties), Kibana_HTTP_APIs_monitoring-alert-cpu-usage-create-rule-body-alerting (13 properties). Each schema is shown below with its type and property counts.
