Upgrade a snapshot

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

Upgrade an anomaly detection model snapshot to the latest major version. Over time, older snapshot formats are deprecated and removed. Anomaly detection jobs support only snapshots that are from the current or previous major version. This API provides a means to upgrade a snapshot to the current major version. This aids in preparing the cluster for an upgrade to the next major version. Only one snapshot per anomaly detection job can be upgraded at a time and the upgraded snapshot cannot be the current snapshot of the anomaly detection job.

Required authorization

Cluster privileges: manage_ml

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST _ml/anomaly_detectors/low_request_rate/model_snapshots/1828371/_upgrade?timeout=45m&wait_for_completion=true

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.upgradeJobSnapshot({
  job_id: "low_request_rate",
  snapshot_id: 1828371,
  timeout: "45m",
  wait_for_completion: "true",
});

Python Elasticsearch Python Client

resp = client.ml.upgrade_job_snapshot(
    job_id="low_request_rate",
    snapshot_id="1828371",
    timeout="45m",
    wait_for_completion=True,
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_ml/anomaly_detectors/low_request_rate/model_snapshots/1828371/_upgrade?timeout=45m&wait_for_completion=true" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ml().upgradeJobSnapshot(u -> u
    .jobId("low_request_rate")
    .snapshotId("1828371")
    .timeout(t -> t
        .offset(45)
    )
    .waitForCompletion(true)
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning
    .UpgradeJobSnapshotAsync(jobId: "low_request_rate", snapshotId: "1828371", d1 => d1
        .Timeout("45m")
        .WaitForCompletion(true)
    );

PHP Elasticsearch PHP Client

$resp = $client->ml()->upgradeJobSnapshot([
    "job_id" => "low_request_rate",
    "snapshot_id" => "1828371",
    "timeout" => "45m",
    "wait_for_completion" => "true",
]);

Ruby Elasticsearch Ruby Client

response = client.ml.upgrade_job_snapshot(
  job_id: "low_request_rate",
  snapshot_id: "1828371",
  timeout: "45m",
  wait_for_completion: "true"
)

Response

No example

Upgrade a snapshot

Required authorization

Path Parameters

Query Parameters

Response

Required authorization

Path Parameters { job_id , snapshot_id , }

Query Parameters { wait_for_completion , timeout , }

Response

Path Parameters

Query Parameters