OpenSearch/docs/reference/ml/anomaly-detection/apis/delete-snapshot.asciidoc

[role="xpack"]
[testenv="platinum"]
[[ml-delete-snapshot]]
=== Delete model snapshots API
++++
<titleabbrev>Delete model snapshots</titleabbrev>
++++

Deletes an existing model snapshot.

[[ml-delete-snapshot-request]]
==== {api-request-title}

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

[[ml-delete-snapshot-prereqs]]
==== {api-prereq-title}

* If the {es} {security-features} are enabled, you must have `manage_ml` or
`manage` cluster privileges to use this API. See <<security-privileges>>.

[[ml-delete-snapshot-desc]]
==== {api-description-title}

IMPORTANT: 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.

[[ml-delete-snapshot-path-parms]]
==== {api-path-parms-title}

`<job_id>`::
(Required, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]

`<snapshot_id>`::
(Required, string)
include::{docdir}/ml/ml-shared.asciidoc[tag=snapshot-id]

[[ml-delete-snapshot-example]]
==== {api-examples-title}

[source,console]
--------------------------------------------------
DELETE _ml/anomaly_detectors/farequote/model_snapshots/1491948163
--------------------------------------------------
// TEST[skip:todo]

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

[source,console-result]
----
{
  "acknowledged": true
}
----