This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« Preview datafeeds API Revert model snapshots API »
Elastic Docs ›Elasticsearch Guide [master] ›REST APIs ›Machine learning anomaly detection APIs

Reset anomaly detection jobs API

edit

Reset anomaly detection jobs API

edit

Resets an existing anomaly detection job.

Request

edit

POST _ml/anomaly_detectors/<job_id>/_reset

Prerequisites

edit
  • Requires the manage_ml cluster privilege. This privilege is included in the machine_learning_admin built-in role.
  • Before you can reset a job, you must close it. You can set force to true when closing the job to avoid waiting for the job to complete. See Close jobs.

Description

edit

All model state and results are deleted. The job is ready to start over as if it had just been created.

It is not currently possible to reset multiple jobs using wildcards or a comma separated list.

Path parameters

edit
<job_id>
(Required, string) Identifier for the anomaly detection job.

Query parameters

edit
wait_for_completion
(Optional, Boolean) Specifies whether the request should return immediately or wait until the job reset completes. Defaults to true.
delete_user_annotations
(Optional, Boolean) Specifies whether annotations that have been added by the user should be deleted along with any auto-generated annotations when the job is reset. Defaults to false.

Examples

edit
resp = client.ml.reset_job(
    job_id="total-requests",
)
print(resp)
response = client.ml.reset_job(
  job_id: 'total-requests'
)
puts response
const response = await client.ml.resetJob({
  job_id: "total-requests",
});
console.log(response);
POST _ml/anomaly_detectors/total-requests/_reset

When the job is reset, you receive the following results:

{
  "acknowledged": true
}

In the next example we reset the total-requests job asynchronously:

resp = client.ml.reset_job(
    job_id="total-requests",
    wait_for_completion=False,
)
print(resp)
response = client.ml.reset_job(
  job_id: 'total-requests',
  wait_for_completion: false
)
puts response
const response = await client.ml.resetJob({
  job_id: "total-requests",
  wait_for_completion: "false",
});
console.log(response);
POST _ml/anomaly_detectors/total-requests/_reset?wait_for_completion=false

When wait_for_completion is set to false, the response contains the id of the job reset task:

{
  "task": "oTUltX4IQMOUUVeiohTt8A:39"
}

If you want to check the status of the reset task, use the Task management by referencing the task ID.

« Preview datafeeds API Revert model snapshots API »