delete-enrich-policy.asciidoc 1.3 KB

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