Update a snapshot

POST /_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_update

Updates certain properties of a snapshot.

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Request body

Response

application/json

acknowledged boolean required
model object required

Examples

Request Console 1 / 8 languages

An example body for a POST request.

Console Kibana Dev Tools

POST
_ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update
{
  "description": "Snapshot 1",
  "retain": true
}

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.updateModelSnapshot({
  job_id: "it_ops_new_logs",
  snapshot_id: 1491852978,
  description: "Snapshot 1",
  retain: true,
});

Python Elasticsearch Python Client

resp = client.ml.update_model_snapshot(
    job_id="it_ops_new_logs",
    snapshot_id="1491852978",
    description="Snapshot 1",
    retain=True,
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_ml/anomaly_detectors/it_ops_new_logs/model_snapshots/1491852978/_update" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Snapshot 1",
    "retain": true
  }'

Java Elasticsearch Java Client

client.ml().updateModelSnapshot(u -> u
    .description("Snapshot 1")
    .jobId("it_ops_new_logs")
    .retain(true)
    .snapshotId("1491852978")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning
    .UpdateModelSnapshotAsync(jobId: "it_ops_new_logs", snapshotId: "1491852978", d1 => d1
        .Description("Snapshot 1")
        .Retain(true)
    );

PHP Elasticsearch PHP Client

$resp = $client->ml()->updateModelSnapshot([
    "job_id" => "it_ops_new_logs",
    "snapshot_id" => "1491852978",
    "body" => [
        "description" => "Snapshot 1",
        "retain" => true,
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.ml.update_model_snapshot(
  job_id: "it_ops_new_logs",
  snapshot_id: "1491852978",
  body: {
    "description": "Snapshot 1",
    "retain": true
  }
)

Response

No example

Required authorization

Authentication

Path parameters

Request body { }

Response

Request body