How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Stack (ELK Stack) Alerting API

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.

Elastic Stack (ELK Stack) Alerting API is one of 132 APIs that Elastic Stack (ELK Stack) 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 an API reference.

This API exposes 23 operations across 19 paths, and defines 52 schemas. It is described by OpenAPI 3.2.0.

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

23 operations 19 paths 52 schemas 3 DELETE6 GET13 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://{elasticsearch_endpoint}
Authentication
API Key, HTTP Basic
Contact
Kibana Team
Resource Areas
1

Authentication & Security 2

Elastic Stack (ELK Stack) 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 23

Across 19 paths, the API surfaces 23 operations — 3 DELETE, 6 GET, 13 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

alerting 23

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…

GET
/api/alerting/_health
Get the alerting framework health
getAlertingHealth → 200401
GET
/api/alerting/rule_types
Get the rule types
getRuleTypes → 200401
DELETE
/api/alerting/rule/{id}
Delete a rule
delete-alerting-rule-id 2 params → 204400403404
GET
/api/alerting/rule/{id}
Get rule details
get-alerting-rule-id 1 param → 200400403404
POST
/api/alerting/rule/{id}
Create a rule
post-alerting-rule-id 2 params body → 200400403409
PUT
/api/alerting/rule/{id}
Update a rule
put-alerting-rule-id 2 params body → 200400403404409
POST
/api/alerting/rule/{id}/_disable
Disable a rule
post-alerting-rule-id-disable 2 params body → 204400403404
POST
/api/alerting/rule/{id}/_enable
Enable a rule
post-alerting-rule-id-enable 2 params → 204400403404
POST
/api/alerting/rule/{id}/_mute_all
Mute all alerts
post-alerting-rule-id-mute-all 2 params → 204400403404
POST
/api/alerting/rule/{id}/_unmute_all
Unmute all alerts
post-alerting-rule-id-unmute-all 2 params → 204400403404
POST
/api/alerting/rule/{id}/_update_api_key
Update the API key for a rule
post-alerting-rule-id-update-api-key 2 params → 204400403404409
GET
/api/alerting/rule/{id}/query_inspector
Get the Elasticsearch query for a rule
get-alerting-rule-id-query-inspector 3 params → 200400404
POST
/api/alerting/rule/{id}/snooze_schedule
Schedule a snooze for the rule
post-alerting-rule-id-snooze-schedule 2 params body → 200400403404
POST
/api/alerting/rule/{rule_id}/alert/{alert_id}/_mute
Mute an alert
post-alerting-rule-rule-id-alert-alert-id-mute 4 params → 204400403404
POST
/api/alerting/rule/{rule_id}/alert/{alert_id}/_snooze
Snooze an alert
post-alerting-rule-rule-id-alert-alert-id-snooze 4 params body → 204400403404
POST
/api/alerting/rule/{rule_id}/alert/{alert_id}/_unmute
Unmute an alert
post-alerting-rule-rule-id-alert-alert-id-unmute 3 params → 204400403404
POST
/api/alerting/rule/{rule_id}/alert/{alert_id}/_unsnooze
Unsnooze an alert
post-alerting-rule-rule-id-alert-alert-id-unsnooze 3 params → 204400403404
DELETE
/api/alerting/rule/{ruleId}/snooze_schedule/{scheduleId}
Delete a snooze schedule for a rule
delete-alerting-rule-ruleid-snooze-schedule-scheduleid 3 params → 204400403404
GET
/api/alerting/rules/_find
Get information about rules
get-alerting-rules-find 11 params → 200400403
POST
/api/alerting/rules/backfill/_find
Find backfills for rules
post-alerting-rules-backfill-find 9 params → 200400403
POST
/api/alerting/rules/backfill/_schedule
Schedule a backfill for rules
post-alerting-rules-backfill-schedule 1 param body → 200400403404
DELETE
/api/alerting/rules/backfill/{id}
Delete a backfill by ID
delete-alerting-rules-backfill-id 2 params → 204400403404
GET
/api/alerting/rules/backfill/{id}
Get a backfill by ID
get-alerting-rules-backfill-id 1 param → 200400403404

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are Kibana_HTTP_APIs_rule_response (29 properties), Kibana_HTTP_APIs_datasetquality-degradeddocs-create-rule-body-alerting (14 properties), Kibana_HTTP_APIs_logs-alert-document-count-create-rule-body-alerting (14 properties), Kibana_HTTP_APIs_xpack-ml-anomaly-detection-alert-create-rule-body-alerting (14 properties). Each schema is shown below with its type and property counts.

Kibana_HTTP_APIs_xpack-uptime-alerts-tlscertificate-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_monitoring-alert-license-expiration-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_monitoring-alert-elasticsearch-version-mismatch-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_new_rule
object
14 properties 4 required
Kibana_HTTP_APIs_find_backfill_response
object
4 properties 4 required
Kibana_HTTP_APIs_xpack-ml-anomaly-detection-jobs-health-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_update_rule
object
10 properties 2 required
Kibana_HTTP_APIs_apm-transaction-duration-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_monitoring-alert-jvm-memory-usage-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_logs-alert-document-count-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_rule_response
object
29 properties 15 required
Kibana_HTTP_APIs_xpack-ml-anomaly-detection-alert-create-rule-body-alerting
object
14 properties 5 required
Alerting_fieldmap_properties
object
10 properties
Kibana_HTTP_APIs_backfill_error_response
object
1 property 1 required
Kibana_HTTP_APIs_schedule_request
object
4 properties 2 required
Kibana_HTTP_APIs_datasetquality-degradeddocs-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_new_rule_action
object
An action that runs under defined conditions.
7 properties 1 required
Kibana_HTTP_APIs_index-threshold-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_monitoring-ccr-read-exceptions-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_slo-rules-burnrate-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_new_rule_action_frequency
object
3 properties 2 required
Kibana_HTTP_APIs_observability-rules-custom-threshold-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_monitoring-alert-missing-monitoring-data-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_backfill_response
object
12 properties 10 required
Kibana_HTTP_APIs_xpack-synthetics-alerts-monitorstatus-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_metrics-alert-threshold-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_update_rule_action_frequency
object
3 properties 2 required
Kibana_HTTP_APIs_rule_flapping
object
When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.
3 properties 2 required
Kibana_HTTP_APIs_es-query-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_apm-anomaly-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_new_rule_action_alerts_filter
object
Conditions that affect whether the action runs. If you specify multiple conditions, all conditions must be met for the action to run. For example, if an alert…
2 properties
Kibana_HTTP_APIs_monitoring-shard-size-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_monitoring-alert-thread-pool-search-rejections-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_monitoring-alert-kibana-version-mismatch-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_xpack-uptime-alerts-monitorstatus-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_monitoring-alert-disk-usage-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_monitoring-alert-logstash-version-mismatch-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_transform-health-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_update_rule_action_alerts_filter
object
2 properties
Kibana_HTTP_APIs_alerts_filter_query
object
3 properties 2 required
Kibana_HTTP_APIs_xpack-synthetics-alerts-tls-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_monitoring-alert-thread-pool-write-rejections-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_apm-transaction-error-rate-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_xpack-uptime-alerts-durationanomaly-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_geo-containment-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_monitoring-alert-nodes-changed-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_monitoring-alert-cpu-usage-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_metrics-alert-inventory-threshold-create-rule-body-alerting
object
14 properties 5 required
Alerting_401_response
object
3 properties
Kibana_HTTP_APIs_apm-error-rate-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_monitoring-alert-cluster-health-create-rule-body-alerting
object
14 properties 5 required
Kibana_HTTP_APIs_update_rule_action
object
An action that runs under defined conditions.
7 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elk-stack-alerting-api-openapi.yml Raw ↑

Other APIs Elastic Stack (ELK Stack) publishes across the network.

Elastic Cloud API
Elastic Stack (ELK Stack) Accounts API
Elastic Stack (ELK Stack) Actions API
Elastic Stack (ELK Stack) agent builder API
Elastic Stack (ELK Stack) Alerting V2 API
Elastic Stack (ELK Stack) Analytics API
Elastic Stack (ELK Stack) APM agent configuration API
Elastic Stack (ELK Stack) APM agent keys API
Elastic Stack (ELK Stack) APM annotations API
Elastic Stack (ELK Stack) APM server schema API
Elastic Stack (ELK Stack) APM sourcemaps API
Elastic Stack (ELK Stack) Authentication API
Where this information came from

This is an independent, third-party profile of Elastic Stack (ELK Stack) Alerting API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.