New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Get query rule Test query ruleset »
Elastic Docs ›Elasticsearch Guide [8.16] ›REST APIs ›Query rules APIs

Delete query rule

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Delete query rule

edit

Removes an individual query rule within an existing query ruleset. This is a destructive action that is only recoverable by re-adding the same rule via the create or update query rule API.

Request

edit

DELETE _query_rules/<ruleset_id>/_rule/<rule_id>

Prerequisites

edit

Requires the manage_search_query_rules privilege.

Path parameters

edit
<ruleset_id>
(Required, string)
<rule_id>
(Required, string)

Response codes

edit
400
Missing ruleset_id, rule_id, or both.
404 (Missing resources)
No query ruleset matching ruleset_id could be found, or else no rule matching rule_id was found in that ruleset.

Examples

edit

The following example deletes the query rule with ID my-rule1 from the query ruleset named my-ruleset:

resp = client.query_rules.delete_rule(
    ruleset_id="my-ruleset",
    rule_id="my-rule1",
)
print(resp)
const response = await client.transport.request({
  method: "DELETE",
  path: "/_query_rules/my-ruleset/_rule/my-rule1",
});
console.log(response);
DELETE _query_rules/my-ruleset/_rule/my-rule1
Copy as curlTry in Elastic 
« Get query rule Test query ruleset »
Was this helpful?
Feedback