Delete a query ruleset

Auth

Remove a query ruleset and its associated data. This is a destructive action that is not recoverable.

Required privileges

ruleset_id string required: The unique identifier of the query ruleset to delete

application/json

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

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

DELETE _query_rules/my-ruleset/

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

resp = client.query_rules.delete_ruleset(
    ruleset_id="my-ruleset",
)

curl Shell

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

Java Elasticsearch Java Client

client.queryRules().deleteRuleset(d -> d
    .rulesetId("my-ruleset")
);

C# Elasticsearch .NET Client

var response = await client.QueryRules.DeleteRulesetAsync(rulesetId: "my-ruleset");

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

response = client.query_rules.delete_ruleset(
  ruleset_id: "my-ruleset"
)

Response

{
  "acknowledged": false
}

Generated from the API spec