---
type: api
title: Alerting
description: 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.
url: https://www.elastic.co/docs/api/doc/kibana/v8/group/endpoint-alerting
resource: https://www.elastic.co/docs/api/doc/kibana/v8/group/endpoint-alerting
products:
  - Kibana
---

# Alerting

`alerting`

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.

[Alerting documentation](https://www.elastic.co/guide/en/kibana/8.19/alerting-getting-started.html)

- [Get the alerting framework health](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-getalertinghealth): `GET` `/api/alerting/_health`, `GET` `/s/{space_id}/api/alerting/_health`
- [Get rule details](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-get-alerting-rule-id): `GET` `/api/alerting/rule/{id}`, `GET` `/s/{space_id}/api/alerting/rule/{id}`
- [Create a rule](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-post-alerting-rule-id): `POST` `/api/alerting/rule/{id}`, `POST` `/s/{space_id}/api/alerting/rule/{id}`
- [Update a rule](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-put-alerting-rule-id): `PUT` `/api/alerting/rule/{id}`, `PUT` `/s/{space_id}/api/alerting/rule/{id}`
- [Delete a rule](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-delete-alerting-rule-id): `DELETE` `/api/alerting/rule/{id}`, `DELETE` `/s/{space_id}/api/alerting/rule/{id}`
- [Disable a rule](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-post-alerting-rule-id-disable): `POST` `/api/alerting/rule/{id}/_disable`, `POST` `/s/{space_id}/api/alerting/rule/{id}/_disable`
- [Enable a rule](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-post-alerting-rule-id-enable): `POST` `/api/alerting/rule/{id}/_enable`, `POST` `/s/{space_id}/api/alerting/rule/{id}/_enable`
- [Mute all alerts](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-post-alerting-rule-id-mute-all): `POST` `/api/alerting/rule/{id}/_mute_all`, `POST` `/s/{space_id}/api/alerting/rule/{id}/_mute_all`
- [Unmute all alerts](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-post-alerting-rule-id-unmute-all): `POST` `/api/alerting/rule/{id}/_unmute_all`, `POST` `/s/{space_id}/api/alerting/rule/{id}/_unmute_all`
- [Update the API key for a rule](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-post-alerting-rule-id-update-api-key): `POST` `/api/alerting/rule/{id}/_update_api_key`, `POST` `/s/{space_id}/api/alerting/rule/{id}/_update_api_key`
- [Schedule a snooze for the rule](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-post-alerting-rule-id-snooze-schedule): `POST` `/api/alerting/rule/{id}/snooze_schedule`, `POST` `/s/{space_id}/api/alerting/rule/{id}/snooze_schedule`
- [Delete a snooze schedule for a rule](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-delete-alerting-rule-ruleid-snooze-schedule-scheduleid): `DELETE` `/api/alerting/rule/{ruleId}/snooze_schedule/{scheduleId}`, `DELETE` `/s/{space_id}/api/alerting/rule/{ruleId}/snooze_schedule/{scheduleId}`
- [Mute an alert](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-post-alerting-rule-rule-id-alert-alert-id-mute): `POST` `/api/alerting/rule/{rule_id}/alert/{alert_id}/_mute`, `POST` `/s/{space_id}/api/alerting/rule/{rule_id}/alert/{alert_id}/_mute`
- [Unmute an alert](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-post-alerting-rule-rule-id-alert-alert-id-unmute): `POST` `/api/alerting/rule/{rule_id}/alert/{alert_id}/_unmute`, `POST` `/s/{space_id}/api/alerting/rule/{rule_id}/alert/{alert_id}/_unmute`
- [Get the rule types](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-getruletypes): `GET` `/api/alerting/rule_types`, `GET` `/s/{space_id}/api/alerting/rule_types`
- [Get information about rules](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-get-alerting-rules-find): `GET` `/api/alerting/rules/_find`, `GET` `/s/{space_id}/api/alerting/rules/_find`
- [Get an alert by identifier](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-legacygetalert): `GET` `/api/alerts/alert/{alertId}`, `GET` `/s/{space_id}/api/alerts/alert/{alertId}`
- [Create an alert](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-legacycreatealert): `POST` `/api/alerts/alert/{alertId}`, `POST` `/s/{space_id}/api/alerts/alert/{alertId}`
- [Update an alert](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-legacyupdatealert): `PUT` `/api/alerts/alert/{alertId}`, `PUT` `/s/{space_id}/api/alerts/alert/{alertId}`
- [Delete an alert](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-legarydeletealert): `DELETE` `/api/alerts/alert/{alertId}`, `DELETE` `/s/{space_id}/api/alerts/alert/{alertId}`
- [Disable an alert](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-legacydisablealert): `POST` `/api/alerts/alert/{alertId}/_disable`, `POST` `/s/{space_id}/api/alerts/alert/{alertId}/_disable`
- [Enable an alert](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-legacyenablealert): `POST` `/api/alerts/alert/{alertId}/_enable`, `POST` `/s/{space_id}/api/alerts/alert/{alertId}/_enable`
- [Mute all alert instances](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-legacymuteallalertinstances): `POST` `/api/alerts/alert/{alertId}/_mute_all`, `POST` `/s/{space_id}/api/alerts/alert/{alertId}/_mute_all`
- [Unmute all alert instances](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-legacyunmuteallalertinstances): `POST` `/api/alerts/alert/{alertId}/_unmute_all`, `POST` `/s/{space_id}/api/alerts/alert/{alertId}/_unmute_all`
- [Mute an alert instance](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-legacymutealertinstance): `POST` `/api/alerts/alert/{alertId}/alert_instance/{alertInstanceId}/_mute`, `POST` `/s/{space_id}/api/alerts/alert/{alertId}/alert_instance/{alertInstanceId}/_mute`
- [Unmute an alert instance](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-legacyunmutealertinstance): `POST` `/api/alerts/alert/{alertId}/alert_instance/{alertInstanceId}/_unmute`, `POST` `/s/{space_id}/api/alerts/alert/{alertId}/alert_instance/{alertInstanceId}/_unmute`
- [Get a paginated set of alerts](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-legacyfindalerts): `GET` `/api/alerts/alerts/_find`, `GET` `/s/{space_id}/api/alerts/alerts/_find`
- [Get the alerting framework health](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-legacygetalertinghealth): `GET` `/api/alerts/alerts/_health`, `GET` `/s/{space_id}/api/alerts/alerts/_health`
- [Get the alert types](https://www.elastic.co/docs/api/doc/kibana/v8/operation/operation-legacygetalerttypes): `GET` `/api/alerts/alerts/list_alert_types`, `GET` `/s/{space_id}/api/alerts/alerts/list_alert_types`