› › ›

Get query ruleset

Retrieves information about a query ruleset.

Request

GET _query_rules/<ruleset_id>

Prerequisites

Requires the manage_search_query_rules privilege.

Path parameters

<ruleset_id>: (Required, string)

Response codes

400: The ruleset_id was not provided.
404 (Missing resources): No query ruleset matching ruleset_id could be found.

Examples

The following example gets the query ruleset named my-ruleset:

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

const response = await client.transport.request({
  method: "GET",
  path: "/_query_rules/my-ruleset",
});
console.log(response);

GET _query_rules/my-ruleset/

A sample 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"
                    }
                ]
            }
        }
    ]
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-query-ruleset.html