IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Delete anomaly detection jobs from calendar API Delete expired data API »
Elastic Docs ›Elasticsearch Guide [8.15] ›REST APIs ›Machine learning anomaly detection APIs

Delete model snapshots API

edit

Delete model snapshots API

edit

Deletes an existing model snapshot.

Request

edit

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

Prerequisites

edit

Requires the manage_ml cluster privilege. This privilege is included in the machine_learning_admin built-in role.

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 anomaly detection job.
<snapshot_id>
(Required, string) Identifier for the model snapshot.

Examples

edit
resp = client.ml.delete_model_snapshot(
    job_id="farequote",
    snapshot_id="1491948163",
)
print(resp)
response = client.ml.delete_model_snapshot(
  job_id: 'farequote',
  snapshot_id: 1_491_948_163
)
puts response
const response = await client.ml.deleteModelSnapshot({
  job_id: "farequote",
  snapshot_id: 1491948163,
});
console.log(response);
DELETE _ml/anomaly_detectors/farequote/model_snapshots/1491948163

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

{
  "acknowledged": true
}
« Delete anomaly detection jobs from calendar API Delete expired data API »