Docs
-->
Elasticsearch Reference [7.0] » X-Pack APIs » Machine learning APIs » Update model snapshots API
«  Update jobs API     Rollup APIs  »

Update model snapshots API

Updates certain properties of a snapshot.

Request

POST _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:

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.

Authorization

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

Examples

The following example updates the snapshot identified as 1491852978:

POST
_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
  }
}
«  Update jobs API     Rollup APIs  »