Get a query ruleset Added in 8.10.0

GET /_query_rules/{ruleset_id}
Api key auth Basic auth Bearer auth

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
      • rule_id string Required
      • type string Required

        Values are pinned or exclude.

      • criteria object | array[object] 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.

        One of:
        _types:QueryRuleCriteria object array-2 array[object]
        Hide attributes Show attributes object
        • type string Required

          Values are global, exact, exact_fuzzy, fuzzy, prefix, suffix, contains, lt, lte, gt, gte, or always.

        • metadata string

          The metadata field to match against. This metadata will be used to match against match_criteria sent in the rule. It is required for all criteria types except always.

        • values array[object]

          The values to match against the metadata field. Only one value must match for the criteria to be met. It is required for all criteria types except always.

      • actions object Required

        Additional properties are allowed.

        Hide actions attributes Show actions attributes object
        • ids array[string]

          The unique document IDs of the documents to apply the rule to. Only one of ids or docs may be specified and at least one must be specified.

        • docs array[object]

          The documents to apply the rule to. Only one of ids or docs may be specified and at least one must be specified. There is a maximum value of 100 documents in a rule. You can specify the following attributes for each document:

          • _index: The index of the document to pin.
          • _id: The unique document ID.
          Hide docs attributes Show docs attributes object
      • priority number
GET /_query_rules/{ruleset_id} 
curl \
 --request GET http://api.example.com/_query_rules/{ruleset_id} \
 --header "Authorization: $API_KEY"
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
    }
  ]
}