Update Model Snapshots API

This API enables you to update certain properties of a snapshot.


POST _xpack/ml/anomaly_detectors/<job_id>/model_snapshots/<snapshot_id>/_update

Path Parameters

job_id (required)
(string) Identifier for the job
snapshot_id (required)
(string) Identifier for the model snapshot

Request Body

The following properties can be updated after the model snapshot is created:

(string) An optional description of the model snapshot. For example, "Before black friday".
(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.


You must have manage_ml, or manage cluster privileges to use this API. For more information, see Security Privileges.


The following example updates the snapshot identified as 1491852978:

  "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