mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-29 09:54:06 -04:00
f56a0f4b66
Removes `testenv` annotations and related code. These annotations originally let you skip x-pack snippet tests in the docs. However, that's no longer possible. Relates to #79309, #31619
55 lines
1.4 KiB
Text
55 lines
1.4 KiB
Text
[role="xpack"]
|
|
[[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}
|
|
|
|
Requires the `manage_ml` cluster privilege. This privilege is included in the
|
|
`machine_learning_admin` built-in role.
|
|
|
|
[[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::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
|
|
|
|
`<snapshot_id>`::
|
|
(Required, string)
|
|
include::{es-repo-dir}/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
|
|
}
|
|
----
|