get-query-rule.asciidoc

Get query rule

Get query rule

New API reference

For the most up-to-date API details, refer to {api-es}/group/endpoint-query_rules[Query rules APIs].

Retrieves information about an individual query rule within a query ruleset.

{api-request-title}

GET _query_rules/<ruleset_id>/_rule/<rule_id>

{api-prereq-title}

Requires the manage_search_query_rules privilege.

{api-path-parms-title}

<ruleset_id>

(Required, string)

<rule_id>

(Required, string)

{api-response-codes-title}

400

Missing ruleset_id or rule_id, or both.

404 (Missing resources)

Either no query ruleset matching ruleset_id could be found, or no rule matching rule_id could be found within that ruleset.

{api-examples-title}

The following example gets the query rule with ID my-rule1 from the ruleset named my-ruleset:

GET _query_rules/my-ruleset/_rule/my-rule1

A sample response:

{
    "rule_id": "my-rule1",
    "type": "pinned",
    "criteria": [
        {
            "type": "contains",
            "metadata": "query_string",
            "values": [ "pugs", "puggles" ]
        }
    ],
    "actions": {
        "ids": [
            "id1",
            "id2"
        ]
    }
}