Get a query ruleset

GET /_query_rules/{ruleset_id}

Get details about a query ruleset.

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Response

application/json

ruleset_id string required: A unique identifier for the ruleset.
rules object[] required: Rules associated with the query ruleset.

Examples

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

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

{
    "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"
                    }
                ]
            }
        }
    ]
}