diff --git a/docs/api/alerting.asciidoc b/docs/api/alerting.asciidoc index cfd20867a298..e5a8d641da55 100644 --- a/docs/api/alerting.asciidoc +++ b/docs/api/alerting.asciidoc @@ -40,8 +40,8 @@ include::alerting/health.asciidoc[leveloffset=+1] include::alerting/get_rules.asciidoc[leveloffset=+1] include::alerting/list_rule_types.asciidoc[leveloffset=+1] include::alerting/update_rule.asciidoc[leveloffset=+1] -include::alerting/mute_all_alerts.asciidoc[] -include::alerting/mute_alert.asciidoc[] -include::alerting/unmute_all_alerts.asciidoc[] -include::alerting/unmute_alert.asciidoc[] +include::alerting/mute_all_alerts.asciidoc[leveloffset=+1] +include::alerting/mute_alert.asciidoc[leveloffset=+1] +include::alerting/unmute_all_alerts.asciidoc[leveloffset=+1] +include::alerting/unmute_alert.asciidoc[leveloffset=+1] include::alerting/legacy/index.asciidoc[] diff --git a/docs/api/alerting/mute_alert.asciidoc b/docs/api/alerting/mute_alert.asciidoc index eef2f055b816..4feb03f72afd 100644 --- a/docs/api/alerting/mute_alert.asciidoc +++ b/docs/api/alerting/mute_alert.asciidoc @@ -1,5 +1,5 @@ [[mute-alert-api]] -=== Mute alert API +== Mute alert API ++++ Mute alert ++++ @@ -7,36 +7,44 @@ Mute an alert. [[mute-alert-api-request]] -==== Request +=== {api-request-title} `POST :/api/alerting/rule//alert//_mute` `POST :/s//api/alerting/rule//alert//_mute` -[[mute-alert-api-path-params]] -==== Path parameters +=== {api-prereq-title} -`rule_id`:: - (Required, string) The ID of the rule whose alert you want to mute. +You must have `all` privileges for the appropriate {kib} 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 *{ml-app}* +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 +<>. + +[[mute-alert-api-path-params]] +=== {api-path-parms-title} `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. [[mute-alert-api-response-codes]] -==== Response code +=== {api-response-codes-title} `200`:: Indicates a successful call. -==== Example - -Mute alert with ID: +=== {api-examples-title} [source,sh] -------------------------------------------------- -$ curl -X POST api/alerting/rule/41893910-6bca-11eb-9e0d-85d233e3ee35/alert/dceeb5d0-6b41-11eb-802b-85b0c1bc8ba2/_mute +POST api/alerting/rule/41893910-6bca-11eb-9e0d-85d233e3ee35/alert/dceeb5d0-6b41-11eb-802b-85b0c1bc8ba2/_mute -------------------------------------------------- // KIBANA diff --git a/docs/api/alerting/mute_all_alerts.asciidoc b/docs/api/alerting/mute_all_alerts.asciidoc index 58b6b14f49b4..329d05257d4f 100644 --- a/docs/api/alerting/mute_all_alerts.asciidoc +++ b/docs/api/alerting/mute_all_alerts.asciidoc @@ -1,5 +1,5 @@ [[mute-all-alerts-api]] -=== Mute all alerts API +== Mute all alerts API ++++ Mute all alerts ++++ @@ -7,14 +7,29 @@ Mute all alerts. [[mute-all-alerts-api-request]] -==== Request +=== {api-request-title} `POST :/api/alerting/rule//_mute_all` `POST :/s//api/alerting/rule//_mute_all` +=== {api-prereq-title} + +You must have `all` privileges for the appropriate {kib} 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 *{ml-app}* +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 +<>. + +=== {api-description-title} + +This API snoozes the notifications for the rule indefinitely. The rule checks +continue to occur but alerts will not trigger any actions. + [[mute-all-alerts-api-path-params]] -==== Path parameters +=== {api-path-parms-title} `id`:: (Required, string) The ID of the rule whose alerts you want to mute. @@ -23,17 +38,15 @@ Mute all alerts. (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. [[mute-all-alerts-api-response-codes]] -==== Response code +=== {api-response-codes-title} `200`:: Indicates a successful call. -==== Example - -Mute all alerts with ID: +=== {api-examples-title} [source,sh] -------------------------------------------------- -$ curl -X POST api/alerting/rule/41893910-6bca-11eb-9e0d-85d233e3ee35/_mute_all +POST api/alerting/rule/41893910-6bca-11eb-9e0d-85d233e3ee35/_mute_all -------------------------------------------------- // KIBANA diff --git a/docs/api/alerting/unmute_alert.asciidoc b/docs/api/alerting/unmute_alert.asciidoc index 4cae7593f99f..d962b480b3ab 100644 --- a/docs/api/alerting/unmute_alert.asciidoc +++ b/docs/api/alerting/unmute_alert.asciidoc @@ -1,5 +1,5 @@ [[unmute-alert-api]] -=== Unmute alert API +== Unmute alert API ++++ Unmute alert ++++ @@ -7,36 +7,44 @@ Unmute an alert. [[unmute-alert-api-request]] -==== Request +=== {api-request-title} `POST :/api/alerting/rule//alert//_unmute` `POST :/s//api/alerting/rule//alert//_unmute` -[[unmute-alert-api-path-params]] -==== Path parameters +=== {api-prereq-title} -`rule_id`:: - (Required, string) The ID of the rule whose alert you want to mute. +You must have `all` privileges for the appropriate {kib} 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 *{ml-app}* +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 +<>. + +[[unmute-alert-api-path-params]] +=== {api-path-parms-title} `alert_id`:: (Required, string) The ID of the alert that you want to unmute. 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. [[unmute-alert-api-response-codes]] -==== Response code +=== {api-response-codes-title} `200`:: Indicates a successful call. -==== Example - -Unmute alert with ID: +=== {api-examples-title} [source,sh] -------------------------------------------------- -$ curl -X POST api/alerting/rule/41893910-6bca-11eb-9e0d-85d233e3ee35/alert/dceeb5d0-6b41-11eb-802b-85b0c1bc8ba2/_unmute +POST api/alerting/rule/41893910-6bca-11eb-9e0d-85d233e3ee35/alert/dceeb5d0-6b41-11eb-802b-85b0c1bc8ba2/_unmute -------------------------------------------------- // KIBANA diff --git a/docs/api/alerting/unmute_all_alerts.asciidoc b/docs/api/alerting/unmute_all_alerts.asciidoc index c429ca288ae7..ea10b9434e91 100644 --- a/docs/api/alerting/unmute_all_alerts.asciidoc +++ b/docs/api/alerting/unmute_all_alerts.asciidoc @@ -1,5 +1,5 @@ [[unmute-all-alerts-api]] -=== Unmute all alerts API +== Unmute all alerts API ++++ Unmute all alerts ++++ @@ -7,14 +7,29 @@ Unmute all alerts. [[unmute-all-alerts-api-all-request]] -==== Request +=== {api-request-title} `POST :/api/alerting/rule//_unmute_all` `POST :/s//api/alerting/rule//_unmute_all` +=== {api-prereq-title} + +You must have `all` privileges for the appropriate {kib} 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 *{ml-app}* +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 +<>. + +=== {api-description-title} + +If the rule has its notifications snoozed indefinitely, this API cancels the +snooze. + [[unmute-all-alerts-api-path-params]] -==== Path parameters +=== {api-path-parms-title} `id`:: (Required, string) The ID of the rule whose alerts you want to unmute. @@ -23,17 +38,15 @@ Unmute all alerts. (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. [[unmute-all-alerts-api-response-codes]] -==== Response code +=== {api-response-codes-title} `200`:: Indicates a successful call. -==== Example - -Unmute all alerts with ID: +=== {api-examples-title} [source,sh] -------------------------------------------------- -$ curl -X POST api/alerting/rule/41893910-6bca-11eb-9e0d-85d233e3ee35/_unmute_all +POST api/alerting/rule/41893910-6bca-11eb-9e0d-85d233e3ee35/_unmute_all -------------------------------------------------- // KIBANA