2018-11-26 11:15:54 -05:00
|
|
|
[role="xpack"]
|
|
|
|
[testenv="platinum"]
|
|
|
|
[[ml-delete-expired-data]]
|
|
|
|
=== Delete Expired Data API
|
|
|
|
++++
|
|
|
|
<titleabbrev>Delete Expired Data</titleabbrev>
|
|
|
|
++++
|
|
|
|
|
|
|
|
Deletes expired and unused machine learning data.
|
|
|
|
|
|
|
|
==== Request
|
|
|
|
|
2018-12-07 15:34:11 -05:00
|
|
|
`DELETE _ml/_delete_expired_data`
|
2018-11-26 11:15:54 -05:00
|
|
|
|
|
|
|
==== Description
|
|
|
|
|
|
|
|
Deletes all job results, model snapshots and forecast data that have exceeded their
|
|
|
|
`retention days` period.
|
|
|
|
Machine Learning state documents that are not associated with any job are also deleted.
|
|
|
|
|
|
|
|
==== Authorization
|
|
|
|
|
|
|
|
You must have `manage_ml`, or `manage` cluster privileges to use this API.
|
|
|
|
For more information, see
|
|
|
|
{stack-ov}/security-privileges.html[Security Privileges] and
|
|
|
|
{stack-ov}/built-in-roles.html[Built-in Roles].
|
|
|
|
|
|
|
|
|
|
|
|
==== Examples
|
|
|
|
|
|
|
|
The endpoint takes no arguments:
|
|
|
|
|
|
|
|
[source,js]
|
|
|
|
--------------------------------------------------
|
2018-12-07 15:34:11 -05:00
|
|
|
DELETE _ml/_delete_expired_data
|
2018-11-26 11:15:54 -05:00
|
|
|
--------------------------------------------------
|
|
|
|
// CONSOLE
|
|
|
|
// TEST
|
|
|
|
|
|
|
|
When the expired data is deleted, you receive the following response:
|
|
|
|
[source,js]
|
|
|
|
----
|
|
|
|
{
|
|
|
|
"deleted": true
|
|
|
|
}
|
|
|
|
----
|
|
|
|
// TESTRESPONSE
|