delete-query-ruleset.asciidoc 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. [role="xpack"]
  2. [[delete-query-ruleset]]
  3. === Delete query ruleset
  4. ++++
  5. <titleabbrev>Delete query ruleset</titleabbrev>
  6. ++++
  7. Removes a query ruleset and its associated data.
  8. This is a destructive action that is not recoverable.
  9. [[delete-query-ruleset-request]]
  10. ==== {api-request-title}
  11. `DELETE _query_rules/<ruleset_id>`
  12. [[delete-query-ruleset-prereq]]
  13. ==== {api-prereq-title}
  14. Requires the `manage_search_query_rules` privilege.
  15. [[delete-query_ruleset-path-params]]
  16. ==== {api-path-parms-title}
  17. `<ruleset_id>`::
  18. (Required, string)
  19. [[delete-query-ruleset-response-codes]]
  20. ==== {api-response-codes-title}
  21. `400`::
  22. The `ruleset_id` was not provided.
  23. `404` (Missing resources)::
  24. No query ruleset matching `ruleset_id` could be found.
  25. [[delete-query-ruleset-example]]
  26. ==== {api-examples-title}
  27. The following example deletes the query ruleset named `my-ruleset`:
  28. ////
  29. [source,console]
  30. ----
  31. PUT _query_rules/my-ruleset
  32. {
  33. "rules": [
  34. {
  35. "rule_id": "my-rule1",
  36. "type": "pinned",
  37. "criteria": [
  38. {
  39. "type": "exact",
  40. "metadata": "query_string",
  41. "values": [ "marvel" ]
  42. }
  43. ],
  44. "actions": {
  45. "ids": ["id1"]
  46. }
  47. }
  48. ]
  49. }
  50. ----
  51. // TESTSETUP
  52. ////
  53. [source,console]
  54. ----
  55. DELETE _query_rules/my-ruleset/
  56. ----