New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Create or update query ruleset List query rulesets »
Elastic Docs ›Elasticsearch Guide [8.12] ›REST APIs ›Query rules APIs

Get query ruleset

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Get query ruleset

edit

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

Retrieves information about a query ruleset.

Request

edit

GET _query_rules/<ruleset_id>

Prerequisites

edit

Requires the manage_search_query_rules privilege.

Path parameters

edit
<ruleset_id>
(Required, string)

Response codes

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

Examples

edit

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

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"
                    }
                ]
            }
        }
    ]
}
« Create or update query ruleset List query rulesets »