delete-query-ruleset.asciidoc 1.4 KB

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