Get a query ruleset Added in 8.10.0

GET /_query_rules/{ruleset_id}

Get details about a query ruleset.

Path parameters

  • ruleset_id string Required

    The unique identifier of the query ruleset

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • ruleset_id string Required
    • rules array[object] Required

      Rules associated with the query ruleset

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