Delete a model snapshot

DELETE /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}

Auth

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.

Required privileges

Cluster privileges manage_ml

Path parameters

job_id string required: Identifier for the anomaly detection job.
snapshot_id string required: Identifier for the model snapshot.

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

DELETE _ml/anomaly_detectors/farequote/model_snapshots/1491948163

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.deleteModelSnapshot({
  job_id: "farequote",
  snapshot_id: 1491948163,
});

Python Elasticsearch Python Client

resp = client.ml.delete_model_snapshot(
    job_id="farequote",
    snapshot_id="1491948163",
)

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_ml/anomaly_detectors/farequote/model_snapshots/1491948163" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ml().deleteModelSnapshot(d -> d
    .jobId("farequote")
    .snapshotId("1491948163")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning.DeleteModelSnapshotAsync(jobId: "farequote", snapshotId: "1491948163");

PHP Elasticsearch PHP Client

$resp = $client->ml()->deleteModelSnapshot([
    "job_id" => "farequote",
    "snapshot_id" => "1491948163",
]);

Ruby Elasticsearch Ruby Client

response = client.ml.delete_model_snapshot(
  job_id: "farequote",
  snapshot_id: "1491948163"
)

Response

A successful response when deleting an existing model snapshot.

{
  "acknowledged": true
}