IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Mute all alerts API
editMute all alerts API
editMute all alerts.
Request
editPOST <kibana host>:<port>/api/alerting/rule/<id>/_mute_all
POST <kibana host>:<port>/s/<space_id>/api/alerting/rule/<id>/_mute_all
Prerequisites
editYou must have all privileges for the appropriate Kibana features, depending on
the consumer and rule_type_id of the rules you’re creating. 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.
Description
editThis API snoozes the notifications for the rule indefinitely. The rule checks continue to occur but alerts will not trigger any actions.
Path parameters
edit-
id - (Required, string) The ID of the rule whose alerts you want to mute.
-
space_id -
(Optional, string) An identifier for the space. If
space_idis not provided in the URL, the default space is used.
Response codes
edit-
200 - Indicates a successful call.
Examples
editPOST api/alerting/rule/41893910-6bca-11eb-9e0d-85d233e3ee35/_mute_all