Get a query rule

GET /_query_rules/{ruleset_id}/_rule/{rule_id}

Get details about a query rule within 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

rule_id string required: A unique identifier for the rule.
type enum required: The type of rule. pinned will identify and pin specific documents to the top of search results. exclude will exclude specific documents from search results.; Values: pinned exclude
criteria union oneOf required: The criteria that must be met for the rule to be applied. If multiple criteria are specified for a rule, all criteria must be met for the rule to be applied.; object or object[]
actions object required: The actions to take when the rule is matched. The format of this action depends on the rule type.
priority number

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

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

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

resp = client.query_rules.get_rule(
    ruleset_id="my-ruleset",
    rule_id="my-rule1",
)

curl Shell

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

Java Elasticsearch Java Client

client.queryRules().getRule(g -> g
    .ruleId("my-rule1")
    .rulesetId("my-ruleset")
);

C# Elasticsearch .NET Client

var response = await client.QueryRules.GetRuleAsync(rulesetId: "my-ruleset", ruleId: "my-rule1");

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

response = client.query_rules.get_rule(
  ruleset_id: "my-ruleset",
  rule_id: "my-rule1"
)

Response

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

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