delete-expired-data.asciidoc 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. [role="xpack"]
  2. [testenv="platinum"]
  3. [[ml-delete-expired-data]]
  4. === Delete expired data API
  5. ++++
  6. <titleabbrev>Delete expired data</titleabbrev>
  7. ++++
  8. Deletes expired and unused machine learning data.
  9. [[ml-delete-expired-data-request]]
  10. ==== {api-request-title}
  11. `DELETE _ml/_delete_expired_data`
  12. [[ml-delete-expired-data-prereqs]]
  13. ==== {api-prereq-title}
  14. * If the {es} {security-features} are enabled, you must have `manage_ml` or
  15. `manage` cluster privileges to use this API. See
  16. <<security-privileges>>.
  17. [[ml-delete-expired-data-desc]]
  18. ==== {api-description-title}
  19. Deletes all job results, model snapshots and forecast data that have exceeded
  20. their `retention days` period. Machine learning state documents that are not
  21. associated with any job are also deleted.
  22. [[ml-delete-expired-data-example]]
  23. ==== {api-examples-title}
  24. The endpoint takes no arguments:
  25. [source,console]
  26. --------------------------------------------------
  27. DELETE _ml/_delete_expired_data
  28. --------------------------------------------------
  29. // TEST
  30. When the expired data is deleted, you receive the following response:
  31. [source,console-result]
  32. ----
  33. {
  34. "deleted": true
  35. }
  36. ----