diff --git a/docs/api/alerting.asciidoc b/docs/api/alerting.asciidoc index 2aca35ab7fe77..ad2d358d17ba0 100644 --- a/docs/api/alerting.asciidoc +++ b/docs/api/alerting.asciidoc @@ -1,47 +1,47 @@ -[[rules-api]] -== Rules APIs +[[alerting-apis]] +== Alerting APIs -The following APIs are available for managing {kib} rules. +The following APIs are available for {kib} alerting. -* <> to create a rule +* <> to create a rule -* <> to update the attributes for existing rules +* <> to update the attributes for existing rules -* <> to retrieve a single rule by ID +* <> to retrieve a single rule by ID -* <> to permanently remove a rule +* <> to permanently remove a rule -* <> to retrieve a paginated set of rules by condition +* <> to retrieve a paginated set of rules by condition -* <> to retrieve a list of rule types +* <> to retrieve a list of rule types -* <> to enable a single rule by ID +* <> to enable a single rule by ID -* <> to disable a single rule by ID +* <> to disable a single rule by ID -* <> to mute alert for a single rule by ID +* <> to mute alert for a single rule by ID -* <> to unmute alert for a single rule by ID +* <> to unmute alert for a single rule by ID -* <> to mute all alerts for a single rule by ID +* <> to mute all alerts for a single rule by ID -* <> to unmute all alerts for a single rule by ID +* <> to unmute all alerts for a single rule by ID -* <> to retrieve the health of the Alerting framework +* <> to retrieve the health of the Alerting framework -For deprecated APIs, refer to <>. +For deprecated APIs, refer to <>. -include::alerting/create.asciidoc[] -include::alerting/update.asciidoc[] -include::alerting/get.asciidoc[] -include::alerting/delete.asciidoc[] -include::alerting/find.asciidoc[] +include::alerting/create_rule.asciidoc[] +include::alerting/update_rule.asciidoc[] +include::alerting/get_rules.asciidoc[] +include::alerting/delete_rule.asciidoc[] +include::alerting/find_rules.asciidoc[] include::alerting/list_rule_types.asciidoc[] -include::alerting/enable.asciidoc[] -include::alerting/disable.asciidoc[] -include::alerting/mute_all.asciidoc[] -include::alerting/mute.asciidoc[] -include::alerting/unmute_all.asciidoc[] -include::alerting/unmute.asciidoc[] +include::alerting/enable_rule.asciidoc[] +include::alerting/disable_rule.asciidoc[] +include::alerting/mute_all_alerts.asciidoc[] +include::alerting/mute_alert.asciidoc[] +include::alerting/unmute_all_alerts.asciidoc[] +include::alerting/unmute_alert.asciidoc[] include::alerting/health.asciidoc[] include::alerting/legacy/index.asciidoc[] diff --git a/docs/api/alerting/create.asciidoc b/docs/api/alerting/create_rule.asciidoc similarity index 97% rename from docs/api/alerting/create.asciidoc rename to docs/api/alerting/create_rule.asciidoc index b1ae5b1db615d..01b6dfc40fcf6 100644 --- a/docs/api/alerting/create.asciidoc +++ b/docs/api/alerting/create_rule.asciidoc @@ -1,4 +1,4 @@ -[[rules-create-api]] +[[create-rule-api]] === Create rule API ++++ Create rule @@ -6,14 +6,14 @@ Create {kib} rules. -[[rules-create-api-request]] +[[create-rule-api-request]] ==== Request `POST :/api/alerting/rule/` `POST :/s//api/alerting/rule/` -[[rules-create-api-path-params]] +[[create-rule-api-path-params]] ==== Path parameters ``:: @@ -22,7 +22,7 @@ Create {kib} rules. `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[rules-create-api-request-body]] +[[create-rule-api-request-body]] ==== Request body `name`:: @@ -80,13 +80,13 @@ There are plans to support multiple other schedule formats in the near future. ===== -[[rules-create-api-request-codes]] +[[create-rule-api-request-codes]] ==== Response code `200`:: Indicates a successful call. -[[rules-create-api-example]] +[[create-rule-api-example]] ==== Example [source,sh] diff --git a/docs/api/alerting/delete.asciidoc b/docs/api/alerting/delete_rule.asciidoc similarity index 87% rename from docs/api/alerting/delete.asciidoc rename to docs/api/alerting/delete_rule.asciidoc index 61cf2ea3d571a..29e642e04c9e2 100644 --- a/docs/api/alerting/delete.asciidoc +++ b/docs/api/alerting/delete_rule.asciidoc @@ -1,4 +1,4 @@ -[[rules-delete-api]] +[[delete-rule-api]] === Delete rule API ++++ Delete rule @@ -8,14 +8,14 @@ Permanently remove a rule. WARNING: Once you delete a rule, you cannot recover it. -[[rules-delete-api-request]] +[[delete-rule-api-request]] ==== Request `DELETE :/api/alerting/rule/` `DELETE :/s//api/alerting/rule/` -[[rules-delete-api-path-params]] +[[delete-rule-api-path-params]] ==== Path parameters `id`:: @@ -24,7 +24,7 @@ WARNING: Once you delete a rule, you cannot recover it. `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[rules-delete-api-response-codes]] +[[delete-rule-api-response-codes]] ==== Response code `200`:: diff --git a/docs/api/alerting/disable.asciidoc b/docs/api/alerting/disable_rule.asciidoc similarity index 86% rename from docs/api/alerting/disable.asciidoc rename to docs/api/alerting/disable_rule.asciidoc index 32934bcbdbec4..ce003335623ef 100644 --- a/docs/api/alerting/disable.asciidoc +++ b/docs/api/alerting/disable_rule.asciidoc @@ -1,4 +1,4 @@ -[[rules-disable-api]] +[[disable-rule-api]] === Disable rule API ++++ Disable rule @@ -6,14 +6,14 @@ Disable a rule. -[[rules-disable-api-request]] +[[disable-rule-api-request]] ==== Request `POST :/api/alerting/rule//_disable` `POST :/s//api/alerting/rule//_disable` -[[rules-disable-api-path-params]] +[[disable-rule-api-path-params]] ==== Path parameters `id`:: @@ -22,7 +22,7 @@ Disable a rule. `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[rules-disable-api-response-codes]] +[[disable-rule-api-response-codes]] ==== Response code `200`:: diff --git a/docs/api/alerting/enable.asciidoc b/docs/api/alerting/enable_rule.asciidoc similarity index 86% rename from docs/api/alerting/enable.asciidoc rename to docs/api/alerting/enable_rule.asciidoc index bb036b304a11a..60f18b3510904 100644 --- a/docs/api/alerting/enable.asciidoc +++ b/docs/api/alerting/enable_rule.asciidoc @@ -1,4 +1,4 @@ -[[rules-enable-api]] +[[enable-rule-api]] === Enable rule API ++++ Enable rule @@ -6,14 +6,14 @@ Enable a rule. -[[rules-enable-api-request]] +[[enable-rule-api-request]] ==== Request `POST :/api/alerting/rule//_enable` `POST :/s//api/alerting/rule//_enable` -[[rules-enable-api-path-params]] +[[enable-rule-api-path-params]] ==== Path parameters `id`:: @@ -22,7 +22,7 @@ Enable a rule. `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[rules-enable-api-response-codes]] +[[enable-rule-api-response-codes]] ==== Response code `200`:: diff --git a/docs/api/alerting/find.asciidoc b/docs/api/alerting/find_rules.asciidoc similarity index 96% rename from docs/api/alerting/find.asciidoc rename to docs/api/alerting/find_rules.asciidoc index 444f64d33d1b9..2df8b3522725c 100644 --- a/docs/api/alerting/find.asciidoc +++ b/docs/api/alerting/find_rules.asciidoc @@ -1,4 +1,4 @@ -[[rules-find-api]] +[[find-rules-api]] === Find rules API ++++ Find rules @@ -9,20 +9,20 @@ Retrieve a paginated set of rules based on condition. NOTE: As rules change in {kib}, the results on each page of the response also change. Use the find API for traditional paginated results, but avoid using it to export large amounts of data. -[[rules-find-api-request]] +[[find-rules-api-request]] ==== Request `GET :/api/alerting/rules/_find` `GET :/s//api/alerting/rules/_find` -[[rules-find-api-path-params]] +[[find-rules-api-path-params]] ==== Path parameters `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[rules-find-api-query-params]] +[[find-rules-api-query-params]] ==== Query Parameters NOTE: Rule `params` are stored as a {ref}/flattened.html[flattened field type] and analyzed as keywords. @@ -59,7 +59,7 @@ NOTE: Rule `params` are stored as a {ref}/flattened.html[flattened field type] a It should look like savedObjectType.attributes.title: "myTitle". However, If you used a direct attribute of a saved object, such as `updatedAt`, you will have to define your filter, for example, savedObjectType.updatedAt > 2018-12-22. -[[rules-find-api-request-codes]] +[[find-rules-api-request-codes]] ==== Response code `200`:: diff --git a/docs/api/alerting/get.asciidoc b/docs/api/alerting/get_rules.asciidoc similarity index 93% rename from docs/api/alerting/get.asciidoc rename to docs/api/alerting/get_rules.asciidoc index a46acadbba5ec..1594ec1fb7ae6 100644 --- a/docs/api/alerting/get.asciidoc +++ b/docs/api/alerting/get_rules.asciidoc @@ -1,4 +1,4 @@ -[[rules-get-api]] +[[get-rule-api]] === Get rule API ++++ Get rule @@ -6,14 +6,14 @@ Retrieve a rule by ID. -[[rules-get-api-request]] +[[get-rule-api-request]] ==== Request `GET :/api/alerting/rule/` `GET :/s//api/alerting/rule/` -[[rules-get-api-params]] +[[get-rule-api-params]] ==== Path parameters `id`:: @@ -22,13 +22,13 @@ Retrieve a rule by ID. `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[rules-get-api-codes]] +[[get-rule-api-codes]] ==== Response code `200`:: Indicates a successful call. -[[rules-get-api-example]] +[[get-rule-api-example]] ==== Example Retrieve the rule object with the ID `41893910-6bca-11eb-9e0d-85d233e3ee35`: diff --git a/docs/api/alerting/health.asciidoc b/docs/api/alerting/health.asciidoc index 354ec9c5b1219..1e6b9ce22a981 100644 --- a/docs/api/alerting/health.asciidoc +++ b/docs/api/alerting/health.asciidoc @@ -1,4 +1,4 @@ -[[alerting-health-api]] +[[get-alerting-framework-health-api]] === Get Alerting framework health API ++++ Get Alerting framework health @@ -6,26 +6,26 @@ Retrieve the health status of the Alerting framework. -[[alerting-health-api-request]] +[[get-alerting-framework-health-api-request]] ==== Request `GET :/api/alerting/_health` `GET :/s//api/alerting/_health` -[[alerting-health-api-params]] +[[get-alerting-framework-health-api-params]] ==== Path parameters `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[alerting-health-api-codes]] +[[get-alerting-framework-health-api-codes]] ==== Response code `200`:: Indicates a successful call. -[[alerting-health-api-example]] +[[get-alerting-framework-health-api-example]] ==== Example Retrieve the health status of the Alerting framework: diff --git a/docs/api/alerting/legacy/create.asciidoc b/docs/api/alerting/legacy/create.asciidoc index eaadce9e32834..9a74d24835489 100644 --- a/docs/api/alerting/legacy/create.asciidoc +++ b/docs/api/alerting/legacy/create.asciidoc @@ -1,4 +1,4 @@ -[[alerts-legacy-api-create]] +[[alerts-api-create]] === Legacy create alert API ++++ Legacy create alert @@ -6,18 +6,18 @@ deprecated::[7.13.0] -Please use the <> instead. +Use the <> instead. Create {kib} alerts. -[[alerts-legacy-api-create-request]] +[[alerts-api-create-request]] ==== Request `POST :/api/alerts/alert/` `POST :/s//api/alerts/alert/` -[[alerts-legacy-api-create-path-params]] +[[alerts-api-create-path-params]] ==== Path parameters ``:: @@ -26,7 +26,7 @@ Create {kib} alerts. `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[alerts-legacy-api-create-request-body]] +[[alerts-api-create-request-body]] ==== Request body `name`:: @@ -87,13 +87,13 @@ There are plans to support multiple other schedule formats in the near future. ===== -[[alerts-legacy-api-create-request-codes]] +[[alerts-api-create-request-codes]] ==== Response code `200`:: Indicates a successful call. -[[alerts-legacy-api-create-example]] +[[alerts-api-create-example]] ==== Example [source,sh] diff --git a/docs/api/alerting/legacy/delete.asciidoc b/docs/api/alerting/legacy/delete.asciidoc index 59090925b9c44..ec619ba836b80 100644 --- a/docs/api/alerting/legacy/delete.asciidoc +++ b/docs/api/alerting/legacy/delete.asciidoc @@ -1,4 +1,4 @@ -[[alerts-legacy-api-delete]] +[[alerts-api-delete]] === Legacy delete alert API ++++ Legacy delete alert @@ -6,20 +6,20 @@ deprecated::[7.13.0] -Please use the <> instead. +Use the <> instead. Permanently remove an alert. WARNING: Once you delete an alert, you cannot recover it. -[[alerts-legacy-api-delete-request]] +[[alerts-api-delete-request]] ==== Request `DELETE :/api/alerts/alert/` `DELETE :/s//api/alerts/alert/` -[[alerts-legacy-api-delete-path-params]] +[[alerts-api-delete-path-params]] ==== Path parameters `id`:: @@ -28,7 +28,7 @@ WARNING: Once you delete an alert, you cannot recover it. `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[alerts-legacy-api-delete-response-codes]] +[[alerts-api-delete-response-codes]] ==== Response code `200`:: diff --git a/docs/api/alerting/legacy/disable.asciidoc b/docs/api/alerting/legacy/disable.asciidoc index 08d002e7b5636..d5cc8ce737436 100644 --- a/docs/api/alerting/legacy/disable.asciidoc +++ b/docs/api/alerting/legacy/disable.asciidoc @@ -1,4 +1,4 @@ -[[alerts-legacy-api-disable]] +[[alerts-api-disable]] === Legacy disable alert API ++++ Legacy disable alert @@ -6,18 +6,18 @@ deprecated::[7.13.0] -Please use the <> instead. +Use the <> instead. Disable an alert. -[[alerts-legacy-api-disable-request]] +[[alerts-api-disable-request]] ==== Request `POST :/api/alerts/alert//_disable` `POST :/s//api/alerts/alert//_disable` -[[alerts-legacy-api-disable-path-params]] +[[alerts-api-disable-path-params]] ==== Path parameters `id`:: @@ -26,7 +26,7 @@ Disable an alert. `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[alerts-legacy-api-disable-response-codes]] +[[alerts-api-disable-response-codes]] ==== Response code `200`:: diff --git a/docs/api/alerting/legacy/enable.asciidoc b/docs/api/alerting/legacy/enable.asciidoc index 918de027dfa0d..44f1a0fce4967 100644 --- a/docs/api/alerting/legacy/enable.asciidoc +++ b/docs/api/alerting/legacy/enable.asciidoc @@ -1,4 +1,4 @@ -[[alerts-legacy-api-enable]] +[[alerts-api-enable]] === Legacy enable alert API ++++ Legacy enable alert @@ -6,18 +6,18 @@ deprecated::[7.13.0] -Plesae use the <> instead. +Plesae use the <> instead. Enable an alert. -[[alerts-legacy-api-enable-request]] +[[alerts-api-enable-request]] ==== Request `POST :/api/alerts/alert//_enable` `POST :/s//api/alerts/alert//_enable` -[[alerts-legacy-api-enable-path-params]] +[[alerts-api-enable-path-params]] ==== Path parameters `id`:: @@ -26,7 +26,7 @@ Enable an alert. `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[alerts-legacy-api-enable-response-codes]] +[[alerts-api-enable-response-codes]] ==== Response code `200`:: diff --git a/docs/api/alerting/legacy/find.asciidoc b/docs/api/alerting/legacy/find.asciidoc index 3f4609376df6a..abbc69316cf2b 100644 --- a/docs/api/alerting/legacy/find.asciidoc +++ b/docs/api/alerting/legacy/find.asciidoc @@ -1,4 +1,4 @@ -[[alerts-legacy-api-find]] +[[alerts-api-find]] === Legacy find alerts API ++++ Legacy find alerts @@ -6,27 +6,27 @@ deprecated::[7.13.0] -Please use the <> instead. +Use the <> instead. Retrieve a paginated set of alerts based on condition. NOTE: As alerts change in {kib}, the results on each page of the response also change. Use the find API for traditional paginated results, but avoid using it to export large amounts of data. -[[alerts-legacy-api-find-request]] +[[alerts-api-find-request]] ==== Request `GET :/api/alerts/_find` `GET :/s//api/alerts/_find` -[[alerts-legacy-api-find-path-params]] +[[alerts-api-find-path-params]] ==== Path parameters `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[alerts-legacy-api-find-query-params]] +[[alerts-api-find-query-params]] ==== Query Parameters NOTE: Alert `params` are stored as a {ref}/flattened.html[flattened field type] and analyzed as keywords. @@ -63,7 +63,7 @@ NOTE: Alert `params` are stored as a {ref}/flattened.html[flattened field type] It should look like savedObjectType.attributes.title: "myTitle". However, If you used a direct attribute of a saved object, such as `updatedAt`, you will have to define your filter, for example, savedObjectType.updatedAt > 2018-12-22. -[[alerts-legacy-api-find-request-codes]] +[[alerts-api-find-request-codes]] ==== Response code `200`:: diff --git a/docs/api/alerting/legacy/get.asciidoc b/docs/api/alerting/legacy/get.asciidoc index b44b148cd40c5..f4cfe4ce6c520 100644 --- a/docs/api/alerting/legacy/get.asciidoc +++ b/docs/api/alerting/legacy/get.asciidoc @@ -1,4 +1,4 @@ -[[alerts-legacy-api-get]] +[[alerts-api-get]] === Legacy get alert API ++++ Legacy get alert @@ -6,18 +6,18 @@ deprecated::[7.13.0] -Please use the <> instead. +Use the <> instead. Retrieve an alert by ID. -[[alerts-legacy-api-get-request]] +[[alerts-api-get-request]] ==== Request `GET :/api/alerts/alert/` `GET :/s//api/alerts/alert/` -[[alerts-legacy-api-get-params]] +[[alerts-api-get-params]] ==== Path parameters `id`:: @@ -26,13 +26,13 @@ Retrieve an alert by ID. `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[alerts-legacy-api-get-codes]] +[[alerts-api-get-codes]] ==== Response code `200`:: Indicates a successful call. -[[alerts-legacy-api-get-example]] +[[alerts-api-get-example]] ==== Example Retrieve the alert object with the ID `41893910-6bca-11eb-9e0d-85d233e3ee35`: diff --git a/docs/api/alerting/legacy/health.asciidoc b/docs/api/alerting/legacy/health.asciidoc index cd2ec824580e8..f2c63dbad7c3b 100644 --- a/docs/api/alerting/legacy/health.asciidoc +++ b/docs/api/alerting/legacy/health.asciidoc @@ -1,4 +1,4 @@ -[[alerts-legacy-api-health]] +[[alerts-api-health]] === Legacy get Alerting framework health API ++++ Legacy get Alerting framework health @@ -6,30 +6,30 @@ deprecated::[7.13.0] -Please use the <> instead. +Use the <> instead. Retrieve the health status of the Alerting framework. -[[alerts-legacy-api-health-request]] +[[alerts-api-health-request]] ==== Request `GET :/api/alerts/_health` `GET :/s//api/alerts/_health` -[[alerts-legacy-api-health-params]] +[[alerts-api-health-params]] ==== Path parameters `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[alerts-legacy-api-health-codes]] +[[alerts-api-health-codes]] ==== Response code `200`:: Indicates a successful call. -[[alerts-legacy-api-health-example]] +[[alerts-api-health-example]] ==== Example Retrieve the health status of the Alerting framework: diff --git a/docs/api/alerting/legacy/index.asciidoc b/docs/api/alerting/legacy/index.asciidoc index 0d7d37b9ed79f..cce2c378bdb58 100644 --- a/docs/api/alerting/legacy/index.asciidoc +++ b/docs/api/alerting/legacy/index.asciidoc @@ -1,4 +1,4 @@ -[[alerts-legacy-apis]] +[[alerts-api]] === Deprecated 7.x APIs These APIs are deprecated and will be removed as of 8.0. diff --git a/docs/api/alerting/legacy/list.asciidoc b/docs/api/alerting/legacy/list.asciidoc index c75590243fa2e..12f7382c542f8 100644 --- a/docs/api/alerting/legacy/list.asciidoc +++ b/docs/api/alerting/legacy/list.asciidoc @@ -1,4 +1,4 @@ -[[alerts-legacy-api-list]] +[[alerts-api-list]] === Legacy list alert types API ++++ Legacy list all alert types @@ -6,30 +6,30 @@ deprecated::[7.13.0] -Please use the <> instead. +Use the <> instead. Retrieve a list of all alert types. -[[alerts-legacy-api-list-request]] +[[alerts-api-list-request]] ==== Request `GET :/api/alerts/list_alert_types` `GET :/s//api/alerts/list_alert_types` -[[alerts-legacy-api-list-params]] +[[alerts-api-list-params]] ==== Path parameters `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[alerts-legacy-api-list-codes]] +[[alerts-api-list-codes]] ==== Response code `200`:: Indicates a successful call. -[[alerts-legacy-api-list-example]] +[[alerts-api-list-example]] ==== Example [source,sh] diff --git a/docs/api/alerting/legacy/mute.asciidoc b/docs/api/alerting/legacy/mute.asciidoc index 5b2cba6a6c4f5..9c9e110dd556c 100644 --- a/docs/api/alerting/legacy/mute.asciidoc +++ b/docs/api/alerting/legacy/mute.asciidoc @@ -1,4 +1,4 @@ -[[alerts-legacy-api-mute]] +[[alerts-api-mute]] === Legacy mute alert instance API ++++ Legacy mute alert instance @@ -6,18 +6,18 @@ deprecated::[7.13.0] -Please use the <> instead. +Use the <> instead. Mute an alert instance. -[[alerts-legacy-api-mute-request]] +[[alerts-api-mute-request]] ==== Request `POST :/api/alerts/alert//alert_instance//_mute` `POST :/s//api/alerts/alert//alert_instance//_mute` -[[alerts-legacy-api-mute-path-params]] +[[alerts-api-mute-path-params]] ==== Path parameters `id`:: @@ -29,7 +29,7 @@ Mute an alert instance. `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[alerts-legacy-api-mute-response-codes]] +[[alerts-api-mute-response-codes]] ==== Response code `200`:: diff --git a/docs/api/alerting/legacy/mute_all.asciidoc b/docs/api/alerting/legacy/mute_all.asciidoc index 2465eb96d9426..c594649ed3693 100644 --- a/docs/api/alerting/legacy/mute_all.asciidoc +++ b/docs/api/alerting/legacy/mute_all.asciidoc @@ -1,4 +1,4 @@ -[[alerts-legacy-api-mute-all]] +[[alerts-api-mute-all]] === Legacy mute all alert instances API ++++ Legacy mute all alert instances @@ -6,18 +6,18 @@ deprecated::[7.13.0] -Please use the <> instead. +Use the <> instead. Mute all alert instances. -[[alerts-legacy-api-mute-all-request]] +[[alerts-api-mute-all-request]] ==== Request `POST :/api/alerts/alert//_mute_all` `POST :/s//api/alerts/alert//_mute_all` -[[alerts-legacy-api-mute-all-path-params]] +[[alerts-api-mute-all-path-params]] ==== Path parameters `id`:: @@ -26,7 +26,7 @@ Mute all alert instances. `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[alerts-legacy-api-mute-all-response-codes]] +[[alerts-api-mute-all-response-codes]] ==== Response code `200`:: diff --git a/docs/api/alerting/legacy/unmute.asciidoc b/docs/api/alerting/legacy/unmute.asciidoc index d30c537c0de04..57a1927010b70 100644 --- a/docs/api/alerting/legacy/unmute.asciidoc +++ b/docs/api/alerting/legacy/unmute.asciidoc @@ -1,4 +1,4 @@ -[[alerts-legacy-api-unmute]] +[[alerts-api-unmute]] === Legacy unmute alert instance API ++++ Legacy unmute alert instance @@ -6,18 +6,18 @@ deprecated::[7.13.0] -Please use the <> instead. +Use the <> instead. Unmute an alert instance. -[[alerts-legacy-api-unmute-request]] +[[alerts-api-unmute-request]] ==== Request `POST :/api/alerts/alert//alert_instance//_unmute` `POST :/s//api/alerts/alert//alert_instance//_unmute` -[[alerts-legacy-api-unmute-path-params]] +[[alerts-api-unmute-path-params]] ==== Path parameters `id`:: @@ -29,7 +29,7 @@ Unmute an alert instance. `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[alerts-legacy-api-unmute-response-codes]] +[[alerts-api-unmute-response-codes]] ==== Response code `200`:: diff --git a/docs/api/alerting/legacy/unmute_all.asciidoc b/docs/api/alerting/legacy/unmute_all.asciidoc index a21ae97f0fa5e..079d00a08c7dc 100644 --- a/docs/api/alerting/legacy/unmute_all.asciidoc +++ b/docs/api/alerting/legacy/unmute_all.asciidoc @@ -1,4 +1,4 @@ -[[alerts-legacy-api-unmute-all]] +[[alerts-api-unmute-all]] === Legacy unmute all alert instances API ++++ Legacy unmute all alert instances @@ -6,18 +6,18 @@ deprecated::[7.13.0] -Please use the <> instead. +Use the <> instead. Unmute all alert instances. -[[alerts-legacy-api-unmute-all-request]] +[[alerts-api-unmute-all-request]] ==== Request `POST :/api/alerts/alert//_unmute_all` `POST :/s//api/alerts/alert//_unmute_all` -[[alerts-legacy-api-unmute-all-path-params]] +[[alerts-api-unmute-all-path-params]] ==== Path parameters `id`:: @@ -26,7 +26,7 @@ Unmute all alert instances. `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[alerts-legacy-api-unmute-all-response-codes]] +[[alerts-api-unmute-all-response-codes]] ==== Response code `200`:: diff --git a/docs/api/alerting/legacy/update.asciidoc b/docs/api/alerting/legacy/update.asciidoc index e704932e4a350..1a4ec723a6d25 100644 --- a/docs/api/alerting/legacy/update.asciidoc +++ b/docs/api/alerting/legacy/update.asciidoc @@ -1,4 +1,4 @@ -[[alerts-legacy-api-update]] +[[alerts-api-update]] === Legacy update alert API ++++ Legacy update alert @@ -6,18 +6,18 @@ deprecated::[7.13.0] -Please use the <> instead. +Use the <> instead. Update the attributes for an existing alert. -[[alerts-legacy-api-update-request]] +[[alerts-api-update-request]] ==== Request `PUT :/api/alerts/alert/` `PUT :/s//api/alerts/alert/` -[[alerts-legacy-api-update-path-params]] +[[alerts-api-update-path-params]] ==== Path parameters `id`:: @@ -26,7 +26,7 @@ Update the attributes for an existing alert. `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[alerts-legacy-api-update-request-body]] +[[alerts-api-update-request-body]] ==== Request body `name`:: @@ -76,13 +76,13 @@ Example: `{ interval: "10s" }`, `{ interval: "5m" }`, `{ interval: "1h" }`, `{ i ===== -[[alerts-legacy-api-update-errors-codes]] +[[alerts-api-update-errors-codes]] ==== Response code `200`:: Indicates a successful call. -[[alerts-legacy-api-update-example]] +[[alerts-api-update-example]] ==== Example Update an alert with ID `ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74` with a different name: diff --git a/docs/api/alerting/list_rule_types.asciidoc b/docs/api/alerting/list_rule_types.asciidoc index 3812296a99e56..77ca8601a6e8b 100644 --- a/docs/api/alerting/list_rule_types.asciidoc +++ b/docs/api/alerting/list_rule_types.asciidoc @@ -1,31 +1,31 @@ -[[alerting-list-rule-types-api]] -=== List alerting rule types API +[[list-rule-types-api]] +=== List rule types API ++++ -List alerting rule types +List rule types ++++ Retrieve a list of alerting rule types. -[[alerting-list-rule-types-api-request]] +[[list-rule-types-api-request]] ==== Request `GET :/api/alerting/rule_types` `GET :/s//api/alerting/rule_types` -[[alerting-list-rule-types-api-params]] +[[list-rule-types-api-params]] ==== Path parameters `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[alerting-list-rule-types-api-codes]] +[[list-rule-types-api-codes]] ==== Response code `200`:: Indicates a successful call. -[[alerting-list-rule-types-api-example]] +[[list-rule-types-api-example]] ==== Example [source,sh] diff --git a/docs/api/alerting/mute.asciidoc b/docs/api/alerting/mute_alert.asciidoc similarity index 89% rename from docs/api/alerting/mute.asciidoc rename to docs/api/alerting/mute_alert.asciidoc index 968d51b6ffe86..4ebf12d1ce10c 100644 --- a/docs/api/alerting/mute.asciidoc +++ b/docs/api/alerting/mute_alert.asciidoc @@ -1,4 +1,4 @@ -[[rules-mute-api]] +[[mute-alert-api]] === Mute alert API ++++ Mute alert @@ -6,14 +6,14 @@ Mute an alert. -[[rules-mute-api-request]] +[[mute-alert-api-request]] ==== Request `POST :/api/alerting/rule//alert//_mute` `POST :/s//api/alerting/rule//alert//_mute` -[[rules-mute-api-path-params]] +[[mute-alert-api-path-params]] ==== Path parameters `rule_id`:: @@ -25,7 +25,7 @@ Mute an alert. `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[rules-mute-api-response-codes]] +[[mute-alert-api-response-codes]] ==== Response code `200`:: diff --git a/docs/api/alerting/mute_all.asciidoc b/docs/api/alerting/mute_all_alerts.asciidoc similarity index 85% rename from docs/api/alerting/mute_all.asciidoc rename to docs/api/alerting/mute_all_alerts.asciidoc index 8ba3a3f8728e2..58b6b14f49b4f 100644 --- a/docs/api/alerting/mute_all.asciidoc +++ b/docs/api/alerting/mute_all_alerts.asciidoc @@ -1,4 +1,4 @@ -[[rules-mute-all-api]] +[[mute-all-alerts-api]] === Mute all alerts API ++++ Mute all alerts @@ -6,14 +6,14 @@ Mute all alerts. -[[rules-mute-all-api-request]] +[[mute-all-alerts-api-request]] ==== Request `POST :/api/alerting/rule//_mute_all` `POST :/s//api/alerting/rule//_mute_all` -[[rules-mute-all-api-path-params]] +[[mute-all-alerts-api-path-params]] ==== Path parameters `id`:: @@ -22,7 +22,7 @@ Mute all alerts. `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[rules-mute-all-api-response-codes]] +[[mute-all-alerts-api-response-codes]] ==== Response code `200`:: diff --git a/docs/api/alerting/unmute.asciidoc b/docs/api/alerting/unmute_alert.asciidoc similarity index 88% rename from docs/api/alerting/unmute.asciidoc rename to docs/api/alerting/unmute_alert.asciidoc index ff3e646cc54d8..6e8870bb2fdae 100644 --- a/docs/api/alerting/unmute.asciidoc +++ b/docs/api/alerting/unmute_alert.asciidoc @@ -1,4 +1,4 @@ -[[rules-unmute-api]] +[[unmute-alert-api]] === Unmute alert API ++++ Unmute alert @@ -6,14 +6,14 @@ Unmute an alert. -[[rules-unmute-api-request]] +[[unmute-alert-api-request]] ==== Request `POST :/api/alerting/rule//alert//_unmute` `POST :/s//api/alerting/rule//alert//_unmute` -[[rules-unmute-api-path-params]] +[[unmute-alert-api-path-params]] ==== Path parameters `rule_id`:: @@ -25,7 +25,7 @@ Unmute an alert. `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[rules-unmute-api-response-codes]] +[[unmute-alert-api-response-codes]] ==== Response code `200`:: diff --git a/docs/api/alerting/unmute_all.asciidoc b/docs/api/alerting/unmute_all_alerts.asciidoc similarity index 84% rename from docs/api/alerting/unmute_all.asciidoc rename to docs/api/alerting/unmute_all_alerts.asciidoc index 5340f664123e9..c429ca288ae79 100644 --- a/docs/api/alerting/unmute_all.asciidoc +++ b/docs/api/alerting/unmute_all_alerts.asciidoc @@ -1,4 +1,4 @@ -[[rules-unmute-all-api]] +[[unmute-all-alerts-api]] === Unmute all alerts API ++++ Unmute all alerts @@ -6,14 +6,14 @@ Unmute all alerts. -[[rules-unmute-all-api-all-request]] +[[unmute-all-alerts-api-all-request]] ==== Request `POST :/api/alerting/rule//_unmute_all` `POST :/s//api/alerting/rule//_unmute_all` -[[rules-unmute-all-api-path-params]] +[[unmute-all-alerts-api-path-params]] ==== Path parameters `id`:: @@ -22,7 +22,7 @@ Unmute all alerts. `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[rules-unmute-all-api-response-codes]] +[[unmute-all-alerts-api-response-codes]] ==== Response code `200`:: diff --git a/docs/api/alerting/update.asciidoc b/docs/api/alerting/update_rule.asciidoc similarity index 95% rename from docs/api/alerting/update.asciidoc rename to docs/api/alerting/update_rule.asciidoc index f3bf45c602bd4..76c88a009be01 100644 --- a/docs/api/alerting/update.asciidoc +++ b/docs/api/alerting/update_rule.asciidoc @@ -1,4 +1,4 @@ -[[rules-update-api]] +[[update-rule-api]] === Update rule API ++++ Update rule @@ -6,14 +6,14 @@ Update the attributes for an existing rule. -[[rules-update-api-request]] +[[update-rule-api-request]] ==== Request `PUT :/api/alerting/rule/` `PUT :/s//api/alerting/rule/` -[[rules-update-api-path-params]] +[[update-rule-api-path-params]] ==== Path parameters `id`:: @@ -22,7 +22,7 @@ Update the attributes for an existing rule. `space_id`:: (Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used. -[[rules-update-api-request-body]] +[[update-rule-api-request-body]] ==== Request body `name`:: @@ -69,13 +69,13 @@ Example: `{ interval: "10s" }`, `{ interval: "5m" }`, `{ interval: "1h" }`, `{ i ===== -[[rules-update-api-response-codes]] +[[update-rule-api-response-codes]] ==== Response code `200`:: Indicates a successful call. -[[rules-update-api-example]] +[[update-rule-api-example]] ==== Example Update a rule with ID `ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74` with a different name: