delete-query-rule.asciidoc 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. [role="xpack"]
  2. [[delete-query-rule]]
  3. === Delete query rule
  4. ++++
  5. <titleabbrev>Delete query rule</titleabbrev>
  6. ++++
  7. Removes an individual query rule within an existing query ruleset.
  8. This is a destructive action that is only recoverable by re-adding the same rule via the <<put-query-rule, create or update query rule>> API.
  9. [[delete-query-rule-request]]
  10. ==== {api-request-title}
  11. `DELETE _query_rules/<ruleset_id>/_rule/<rule_id>`
  12. [[delete-query-rule-prereq]]
  13. ==== {api-prereq-title}
  14. Requires the `manage_search_query_rules` privilege.
  15. [[delete-query_rule-path-params]]
  16. ==== {api-path-parms-title}
  17. `<ruleset_id>`::
  18. (Required, string)
  19. `<rule_id>`::
  20. (Required, string)
  21. [[delete-query-rule-response-codes]]
  22. ==== {api-response-codes-title}
  23. `400`::
  24. Missing `ruleset_id`, `rule_id`, or both.
  25. `404` (Missing resources)::
  26. No query ruleset matching `ruleset_id` could be found, or else no rule matching `rule_id` was found in that ruleset.
  27. [[delete-query-rule-example]]
  28. ==== {api-examples-title}
  29. The following example deletes the query rule with ID `my-rule1` from the query ruleset named `my-ruleset`:
  30. ////
  31. [source,console]
  32. ----
  33. PUT _query_rules/my-ruleset
  34. {
  35. "rules": [
  36. {
  37. "rule_id": "my-rule1",
  38. "type": "pinned",
  39. "criteria": [
  40. {
  41. "type": "exact",
  42. "metadata": "query_string",
  43. "values": [ "marvel" ]
  44. }
  45. ],
  46. "actions": {
  47. "ids": ["id1"]
  48. }
  49. }
  50. ]
  51. }
  52. ----
  53. // TESTSETUP
  54. ////
  55. [source,console]
  56. ----
  57. DELETE _query_rules/my-ruleset/_rule/my-rule1
  58. ----