Upgrade a snapshot

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

Auth

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

Path parameters

job_id string required: Identifier for the anomaly detection job.
snapshot_id string required: A numerical character string that uniquely identifies the model snapshot.

Query parameters

wait_for_completion boolean · default: false: When true, the API won’t respond until the upgrade is complete. Otherwise, it responds as soon as the upgrade task is assigned to a node.
timeout string · default: 30m: Controls the time to wait for the request to complete.

Response

application/json

node string required: The ID of the node that the upgrade task was started on if it is still running. In serverless this will be the "serverless".
completed boolean required: When true, this means the task is complete. When false, it is still running.