-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch '8.5' into backport/8.5/pr-141239
- Loading branch information
Showing
70 changed files
with
950 additions
and
1,600 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,42 +1,50 @@ | ||
[[mute-alert-api]] | ||
=== Mute alert API | ||
== Mute alert API | ||
++++ | ||
<titleabbrev>Mute alert</titleabbrev> | ||
++++ | ||
|
||
Mute an alert. | ||
|
||
[[mute-alert-api-request]] | ||
==== Request | ||
=== {api-request-title} | ||
|
||
`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` | ||
|
||
[[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 | ||
<<kibana-feature-privileges>>. | ||
|
||
[[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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,42 +1,50 @@ | ||
[[unmute-alert-api]] | ||
=== Unmute alert API | ||
== Unmute alert API | ||
++++ | ||
<titleabbrev>Unmute alert</titleabbrev> | ||
++++ | ||
|
||
Unmute an alert. | ||
|
||
[[unmute-alert-api-request]] | ||
==== Request | ||
=== {api-request-title} | ||
|
||
`POST <kibana host>:<port>/api/alerting/rule/<rule_id>/alert/<alert_id>/_unmute` | ||
|
||
`POST <kibana host>:<port>/s/<space_id>/api/alerting/rule/<rule_id>/alert/<alert_id>/_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 | ||
<<kibana-feature-privileges>>. | ||
|
||
[[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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.