delete-enrich-policy.asciidoc 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[delete-enrich-policy-api]]
  4. === Delete enrich policy API
  5. ++++
  6. <titleabbrev>Delete enrich policy</titleabbrev>
  7. ++++
  8. Deletes an existing <<enrich-policy,enrich policy>> and its
  9. <<enrich-index,enrich index>>.
  10. ////
  11. [source,console]
  12. ----
  13. PUT /users
  14. {
  15. "mappings" : {
  16. "properties" : {
  17. "email" : { "type" : "keyword" }
  18. }
  19. }
  20. }
  21. PUT /_enrich/policy/my-policy
  22. {
  23. "match": {
  24. "indices": "users",
  25. "match_field": "email",
  26. "enrich_fields": ["first_name", "last_name", "city", "zip", "state"]
  27. }
  28. }
  29. ----
  30. // TESTSETUP
  31. ////
  32. [source,console]
  33. --------------------------------------------------
  34. DELETE /_enrich/policy/my-policy
  35. --------------------------------------------------
  36. [[delete-enrich-policy-api-request]]
  37. ==== {api-request-title}
  38. `DELETE /_enrich/policy/<enrich-policy>`
  39. [[delete-enrich-policy-api-prereqs]]
  40. ==== {api-prereq-title}
  41. include::put-enrich-policy.asciidoc[tag=enrich-policy-api-prereqs]
  42. [[delete-enrich-policy-api-desc]]
  43. ==== {api-description-title}
  44. Use the delete enrich policy API
  45. to delete an existing enrich policy
  46. and its enrich index.
  47. [IMPORTANT]
  48. ====
  49. You must remove an enrich policy
  50. from any in-use ingest pipelines
  51. before deletion.
  52. You cannot remove in-use enrich policies.
  53. ====
  54. [[delete-enrich-policy-api-path-params]]
  55. ==== {api-path-parms-title}
  56. `<enrich-policy>`::
  57. (Required, string)
  58. Enrich policy to delete.