56 lines
1.2 KiB
Plaintext
56 lines
1.2 KiB
Plaintext
[role="xpack"]
|
|
[testenv="platinum"]
|
|
[[ml-delete-snapshot]]
|
|
=== Delete Model Snapshots API
|
|
++++
|
|
<titleabbrev>Delete Model Snapshots</titleabbrev>
|
|
++++
|
|
|
|
Deletes 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. To identify the active model snapshot, refer to
|
|
the `model_snapshot_id` in the results from the get jobs API.
|
|
|
|
==== Path Parameters
|
|
|
|
`job_id` (required)::
|
|
(string) Identifier for the job
|
|
|
|
`snapshot_id` (required)::
|
|
(string) Identifier for the model snapshot
|
|
|
|
|
|
==== Authorization
|
|
|
|
You must have `manage_ml`, or `manage` cluster privileges to use this API.
|
|
For more information, see {xpack-ref}/security-privileges.html[Security Privileges].
|
|
|
|
|
|
==== Examples
|
|
|
|
The following example deletes the `1491948163` snapshot:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
DELETE _xpack/ml/anomaly_detectors/farequote/model_snapshots/1491948163
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[skip:todo]
|
|
|
|
When the snapshot is deleted, you receive the following results:
|
|
[source,js]
|
|
----
|
|
{
|
|
"acknowledged": true
|
|
}
|
|
----
|
|
// TESTRESPONSE |