OpenSearch/docs/reference/ml/apis/delete-expired-data.asciidoc

48 lines
1.0 KiB
Plaintext

[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
`DELETE _ml/_delete_expired_data`
==== 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]
--------------------------------------------------
DELETE _ml/_delete_expired_data
--------------------------------------------------
// CONSOLE
// TEST
When the expired data is deleted, you receive the following response:
[source,js]
----
{
"deleted": true
}
----
// TESTRESPONSE