delete-expired-data.asciidoc 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  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-desc]]
  13. ==== {api-description-title}
  14. Deletes all job results, model snapshots and forecast data that have exceeded
  15. their `retention days` period. Machine learning state documents that are not
  16. associated with any job are also deleted.
  17. [[ml-delete-expired-data-prereqs]]
  18. ==== {api-prereq-title}
  19. You must have `manage_ml`, or `manage` cluster privileges to use this API.
  20. For more information, see
  21. {stack-ov}/security-privileges.html[Security Privileges] and
  22. {stack-ov}/built-in-roles.html[Built-in Roles].
  23. [[ml-delete-expired-data-example]]
  24. ==== {api-examples-title}
  25. The endpoint takes no arguments:
  26. [source,js]
  27. --------------------------------------------------
  28. DELETE _ml/_delete_expired_data
  29. --------------------------------------------------
  30. // CONSOLE
  31. // TEST
  32. When the expired data is deleted, you receive the following response:
  33. [source,js]
  34. ----
  35. {
  36. "deleted": true
  37. }
  38. ----
  39. // TESTRESPONSE