Get a query ruleset

GET /_query_rules/{ruleset_id}

Api key auth Basic auth Bearer auth

Get details about a query ruleset.

Required authorization

Cluster privileges: manage_search_query_rules

About seeing rules and rulesets

Path Parameters

ruleset_id string Id required: The unique identifier of the query ruleset

Response

application/json

Examples

A successful response from GET _query_rules/my-ruleset/.

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _query_rules/my-ruleset/

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

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

Java Elasticsearch Java Client

client.queryRules().getRuleset(g -> g
    .rulesetId("my-ruleset")
);

C# Elasticsearch .NET Client

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

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

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

Response

{
    "ruleset_id": "my-ruleset",
    "rules": [
        {
            "rule_id": "my-rule1",
            "type": "pinned",
            "criteria": [
                {
                    "type": "contains",
                    "metadata": "query_string",
                    "values": [ "pugs", "puggles" ]
                }
            ],
            "actions": {
                "ids": [
                    "id1",
                    "id2"
                ]
            }
        },
        {
            "rule_id": "my-rule2",
            "type": "pinned",
            "criteria": [
                {
                    "type": "fuzzy",
                    "metadata": "query_string",
                    "values": [ "rescue dogs" ]
                }
            ],
            "actions": {
                "docs": [
                    {
                        "_index": "index1",
                        "_id": "id3"
                    },
                    {
                        "_index": "index2",
                        "_id": "id4"
                    }
                ]
            }
        }
    ]
}