WARNING: Version 5.4 of the Elastic Stack has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Update Model Snapshotsedit
The update model snapshot API enables you to update certain properties of a snapshot.
Requestedit
POST _xpack/ml/anomaly_detectors/<job_id>/model_snapshots/<snapshot_id>/_update
Path Parametersedit
-
job_id
(required) - (string) Identifier for the job
-
snapshot_id
(required) - (string) Identifier for the model snapshot
Request Bodyedit
The following properties can be updated after the model snapshot is created:
-
description
- (string) An optional description of the model snapshot. For example, "Before black friday".
-
retain
-
(boolean) If true, this snapshot will not be deleted during automatic cleanup
of snapshots older than
model_snapshot_retention_days
. Note that this snapshot will still be deleted when the job is deleted. The default value is false.
Authorizationedit
You must have manage_ml
, or manage
cluster privileges to use this API.
For more information, see Cluster Privileges.
Examplesedit
The following example updates the snapshot identified as 1491852978
:
POST _xpack/ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update { "description": "Snapshot 1", "retain": true }
When the snapshot is updated, you receive the following results:
{ "acknowledged": true, "model": { "job_id": "it_ops_new_logs", "timestamp": 1491852978000, "description": "Snapshot 1", ... "retain": true } }