Mute alert API

edit

Mute an alert.

For the most up-to-date API details, refer to the open API specification.

Request

edit

POST <kibana host>:<port>/api/alerting/rule/<rule_id>/alert/<alert_id>/_mute

POST <kibana host>:<port>/s/<space_id>/api/alerting/rule/<rule_id>/alert/<alert_id>/_mute

Prerequisites

edit

You must have all privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rule. For example, the Management > Stack Rules feature, Analytics > Discover and Machine Learning features, Observability, and Security features. If the rule has actions, you must also have read privileges for the Management > Actions and Connectors feature. For more details, refer to Feature privileges.

Path parameters

edit
alert_id
(Required, string) The ID of the alert that you want to mute. The alert_id is generated by the rule and might be any arbitrary string.
rule_id
(Required, string) The ID of the rule whose alert you want to mute.
space_id
(Optional, string) An identifier for the space. If space_id is not provided in the URL, the default space is used.

Response codes

edit
204
Indicates a successful call.

Examples

edit
POST api/alerting/rule/41893910-6bca-11eb-9e0d-85d233e3ee35/alert/dceeb5d0-6b41-11eb-802b-85b0c1bc8ba2/_mute