Delete expired data API

Deletes expired and unused machine learning data.

Request

DELETE _ml/_delete_expired_data

DELETE _ml/_delete_expired_data/<job_id>

Prerequisites

• If the Elasticsearch security features are enabled, you must have manage_ml or manage cluster privileges to use this API. See Security privileges and Machine learning security privileges.

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.

You can limit the request to a single or set of anomaly detection jobs by using a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. You can delete expired data for all anomaly detection jobs by using _all, by specifying * as the <job_id>, or by omitting the <job_id>.

Path parameters

<job_id>

(Optional, string) Identifier for an anomaly detection job. It can be a job identifier, a group name, or a wildcard expression.

Request body

requests_per_second

(Optional, float) The desired requests per second for the deletion processes. The default behavior is no throttling.

timeout

(Optional, string) How long can the underlying delete processes run until they are canceled. The default value is 8h (8 hours).

Examples

The endpoint takes no arguments:

DELETE _ml/_delete_expired_data

When the expired data is deleted, you receive the following response:

{
  "deleted": true
}