Delete model snapshots API

edit

Deletes an existing model snapshot.

Request

edit

DELETE _ml/anomaly_detectors/<job_id>/model_snapshots/<snapshot_id>

Prerequisites

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

Description

edit

You cannot delete the active model snapshot. To delete that snapshot, first revert to a different one. To identify the active model snapshot, refer to the model_snapshot_id in the results from the get jobs API.

Path parameters

edit
<job_id>
(Required, string) Identifier for the job.
<snapshot_id>
(Required, string) Identifier for the model snapshot.

Examples

edit

The following example deletes the 1491948163 snapshot:

DELETE _ml/anomaly_detectors/farequote/model_snapshots/1491948163

When the snapshot is deleted, you receive the following results:

{
  "acknowledged": true
}