Get all query rulesets

GET /_query_rules

Auth

Get summarized information about the query rulesets.

About seeing rules and rulesets

Required authorization

Cluster privileges manage_search_query_rules

Query parameters

from number · default: 0: The offset from the first result to fetch.
size number · default: 100: The maximum number of results to retrieve.

Response

application/json

count number required
results object[] required

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _query_rules/?from=0&size=3

JavaScript Elasticsearch JavaScript Client

const response = await client.queryRules.listRulesets({
  from: 0,
  size: 3,
});

Python Elasticsearch Python Client

resp = client.query_rules.list_rulesets(
    from_="0",
    size="3",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_query_rules/?from=0&size=3" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.queryRules().listRulesets(l -> l
    .from(0)
    .size(3)
);

C# Elasticsearch .NET Client

var response = await client.QueryRules
    .ListRulesetsAsync(d1 => d1
        .From(0)
        .Size(3)
    );

PHP Elasticsearch PHP Client

$resp = $client->queryRules()->listRulesets([
    "from" => "0",
    "size" => "3",
]);

Ruby Elasticsearch Ruby Client

response = client.query_rules.list_rulesets(
  from: "0",
  size: "3"
)

Response

A successful response from GET _query_rules/?from=0&size=3.

{
    "count": 3,
    "results": [
        {
            "ruleset_id": "ruleset-1",
            "rule_total_count": 1,
            "rule_criteria_types_counts": {
                "exact": 1
            }
        },
        {
            "ruleset_id": "ruleset-2",
            "rule_total_count": 2,
            "rule_criteria_types_counts": {
                "exact": 1,
                "fuzzy": 1
            }
        },
        {
            "ruleset_id": "ruleset-3",
            "rule_total_count": 3,
            "rule_criteria_types_counts": {
                "exact": 1,
                "fuzzy": 2
            }
        }
    ]
}