Delete a query rule

DELETE /_query_rules/{ruleset_id}/_rule/{rule_id}

Auth

Delete a query rule within a query ruleset. This is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API.

About deleting a query rule

Required privileges

Cluster privileges manage_search_query_rules

Path parameters

ruleset_id string required: The unique identifier of the query ruleset containing the rule to delete
rule_id string required: The unique identifier of the query rule within the specified ruleset to delete

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

DELETE _query_rules/my-ruleset/_rule/my-rule1

JavaScript Elasticsearch JavaScript Client

const response = await client.queryRules.deleteRule({
  ruleset_id: "my-ruleset",
  rule_id: "my-rule1",
});

Python Elasticsearch Python Client

resp = client.query_rules.delete_rule(
    ruleset_id="my-ruleset",
    rule_id="my-rule1",
)

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_query_rules/my-ruleset/_rule/my-rule1" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.queryRules().deleteRule(d -> d
    .ruleId("my-rule1")
    .rulesetId("my-ruleset")
);

C# Elasticsearch .NET Client

var response = await client.QueryRules.DeleteRuleAsync(rulesetId: "my-ruleset", ruleId: "my-rule1");

PHP Elasticsearch PHP Client

$resp = $client->queryRules()->deleteRule([
    "ruleset_id" => "my-ruleset",
    "rule_id" => "my-rule1",
]);

Ruby Elasticsearch Ruby Client

response = client.query_rules.delete_rule(
  ruleset_id: "my-ruleset",
  rule_id: "my-rule1"
)

Response

{
  "acknowledged": false
}

Generated from the API spec