elasticsearch/docs/reference/query-rules/apis/delete-query-ruleset.asciidoc
2024-12-31 20:19:47 +00:00

77 lines
1.5 KiB
Text

[role="xpack"]
[[delete-query-ruleset]]
=== Delete query ruleset
++++
<titleabbrev>Delete query ruleset</titleabbrev>
++++
.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-query_rules[Query rules APIs].
--
Removes a query ruleset and its associated data.
This is a destructive action that is not recoverable.
[[delete-query-ruleset-request]]
==== {api-request-title}
`DELETE _query_rules/<ruleset_id>`
[[delete-query-ruleset-prereq]]
==== {api-prereq-title}
Requires the `manage_search_query_rules` privilege.
[[delete-query_ruleset-path-params]]
==== {api-path-parms-title}
`<ruleset_id>`::
(Required, string)
[[delete-query-ruleset-response-codes]]
==== {api-response-codes-title}
`400`::
The `ruleset_id` was not provided.
`404` (Missing resources)::
No query ruleset matching `ruleset_id` could be found.
[[delete-query-ruleset-example]]
==== {api-examples-title}
The following example deletes the query ruleset named `my-ruleset`:
////
[source,console]
----
PUT _query_rules/my-ruleset
{
"rules": [
{
"rule_id": "my-rule1",
"type": "pinned",
"criteria": [
{
"type": "exact",
"metadata": "query_string",
"values": [ "marvel" ]
}
],
"actions": {
"ids": ["id1"]
}
}
]
}
----
// TESTSETUP
////
[source,console]
----
DELETE _query_rules/my-ruleset/
----