OpenSearch/docs/en/rest-api/ml/delete-snapshot.asciidoc

[[ml-delete-snapshot]]
==== Delete Model Snapshots

The delete model snapshot API enables you to delete an existing model snapshot.

===== Request

`DELETE _xpack/ml/anomaly_detectors/<job_id>/model_snapshots/<snapshot_id>`


===== Description

IMPORTANT: You cannot delete the active model snapshot. To delete that snapshot,
first revert to a different one.

//TBD: Where do you see restorePriority? Per old docs, the active model snapshot
//is "...the snapshot with the highest restorePriority".

===== Path Parameters

`job_id` (required)::
  (+string+) Identifier for the job

`snapshot_id` (required)::
  (+string+) Identifier for the model snapshot
////
===== Responses

200
(EmptyResponse) The cluster has been successfully deleted
404
(BasicFailedReply) The cluster specified by {cluster_id} cannot be found (code: clusters.cluster_not_found)
412
(BasicFailedReply) The Elasticsearch cluster has not been shutdown yet (code: clusters.cluster_plan_state_error)


===== Examples

The following example deletes the `event_rate` job:

[source,js]
--------------------------------------------------
DELETE _xpack/ml/anomaly_detectors/event_rate
--------------------------------------------------
// CONSOLE
// TEST[skip:todo]

When the job is deleted, you receive the following results:
----
{
  "acknowledged": true
}
----
////