Revert to a snapshot

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

The machine learning features react quickly to anomalous input, learning new behaviors in data. Highly anomalous input increases the variance in the models whilst the system learns whether this is a new step-change in behavior or a one-off event. In the case where this anomalous input is known to be a one-off, then it might be appropriate to reset the model state to a time before this event. For example, you might consider reverting to a saved snapshot after Black Friday or a critical system failure.

Required authorization

Cluster privileges: manage_ml

Path Parameters

Query Parameters

delete_intervening_results boolean · default: false: If true, deletes the results in the time period between the latest results and the time of the reverted snapshot. It also resets the model to accept records for this time period. If you choose not to delete intervening results when reverting a snapshot, the job will not accept input data that is older than the current time. If you want to resend data, then delete the intervening results.

Request

delete_intervening_results boolean · default: false: Refer to the description for the delete_intervening_results query parameter.

Response

application/json

Examples

An example body for a POST _ml/anomaly_detectors/low_request_rate/model_snapshots/1637092688/_revert request.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST _ml/anomaly_detectors/low_request_rate/model_snapshots/1637092688/_revert
{
  "delete_intervening_results": true
}

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.revertModelSnapshot({
  job_id: "low_request_rate",
  snapshot_id: 1637092688,
  delete_intervening_results: true,
});

Python Elasticsearch Python Client

resp = client.ml.revert_model_snapshot(
    job_id="low_request_rate",
    snapshot_id="1637092688",
    delete_intervening_results=True,
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_ml/anomaly_detectors/low_request_rate/model_snapshots/1637092688/_revert" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "delete_intervening_results": true
  }'

Java Elasticsearch Java Client

client.ml().revertModelSnapshot(r -> r
    .deleteInterveningResults(true)
    .jobId("low_request_rate")
    .snapshotId("1637092688")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning
    .RevertModelSnapshotAsync(jobId: "low_request_rate", snapshotId: "1637092688", d1 => d1
        .DeleteInterveningResults(true)
    );

PHP Elasticsearch PHP Client

$resp = $client->ml()->revertModelSnapshot([
    "job_id" => "low_request_rate",
    "snapshot_id" => "1637092688",
    "body" => [
        "delete_intervening_results" => true,
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.ml.revert_model_snapshot(
  job_id: "low_request_rate",
  snapshot_id: "1637092688",
  body: {
    "delete_intervening_results": true
  }
)

Response

No example

Required authorization

Path Parameters { job_id , snapshot_id , }

Query Parameters

Request

Response

Path Parameters