github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Adds prerequisites to delete rule API (#134408)

Browse source
This commit is contained in:
Lisa Cawley 2022-06-15 09:00:11 -07:00 • committed by GitHub
parent 5c8b8bebdf
commit 9590525c57
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/api/alerting.asciidoc
View file

@ -32,9 +32,9 @@ The following APIs are available for Alerting.
For deprecated APIs, refer to <<alerts-api>>.
include::alerting/create_rule.asciidoc[leveloffset=+1]
include::alerting/delete_rule.asciidoc[leveloffset=+1]
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_rule.asciidoc[]

31
docs/api/alerting/delete_rule.asciidoc
View file

@ -1,41 +1,46 @@
[[delete-rule-api]]
=== Delete rule API
== Delete rule API
++++
<titleabbrev>Delete rule</titleabbrev>
++++
Permanently remove a rule.
Permanently removes a rule.
WARNING: Once you delete a rule, you cannot recover it.
WARNING: After you delete a rule, you cannot recover it.
[[delete-rule-api-request]]
==== Request
=== {api-request-title}
`DELETE <kibana host>:<port>/api/alerting/rule/<id>`
`DELETE <kibana host>:<port>/s/<space_id>/api/alerting/rule/<id>`
=== {api-prereq-title}
You must have `all` privileges for the *Management* > *Stack Rules* feature or
for the *{ml-app}*, *{observability}*, or *Security* features, depending on the
`consumer` and `rule_type_id` of the rule you're deleting.
[[delete-rule-api-path-params]]
==== Path parameters
=== {api-path-parms-title}
`id`::
(Required, string) The ID of the rule that you want to remove.
(Required, string) The identifier of the rule that you want to remove.
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
(Optional, string) An identifier for the space. If it is not specified, the
default space is used.
[[delete-rule-api-response-codes]]
==== Response code
=== {api-response-codes-title}
`200`::
Indicates a successful call.
Indicates a successful call.
==== Example
Delete a rule with ID:
=== {api-examples-title}
[source,sh]
--------------------------------------------------
$ curl -X DELETE api/alerting/rule/41893910-6bca-11eb-9e0d-85d233e3ee35
DELETE api/alerting/rule/41893910-6bca-11eb-9e0d-85d233e3ee35
--------------------------------------------------
// KIBANA