Get a query rule Added in 8.15.0

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

Get details about a query rule within a query ruleset.

External documentation

Path parameters

  • ruleset_id string Required

    The unique identifier of the query ruleset containing the rule to retrieve

  • rule_id string Required

    The unique identifier of the query rule within the specified ruleset to retrieve

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
GET /_query_rules/{ruleset_id}/_rule/{rule_id} 
curl \
 -X GET http://api.example.com/_query_rules/{ruleset_id}/_rule/{rule_id}
Response examples (200) 
{
  "rule_id": "string",
  "type": "pinned",
  "criteria": {
    "type": "global",
    "metadata": "string",
    "values": [
      {}
    ]
  },
  "actions": {
    "ids": [
      "string"
    ],
    "docs": [
      {
        "_id": "string",
        "_index": "string"
      }
    ]
  },
  "priority": 42.0
}