Reset an anomaly detection job Generally available; Added in 7.14.0

POST /_ml/anomaly_detectors/{job_id}/_reset
Api key auth Basic auth Bearer auth

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.

highlight#highlightFromAnchor" href="#topic-required-authorization"> Required authorization

  • Cluster privileges: manage_ml

Path parameters

  • job_id string Required

    The ID of the job to reset.

Query parameters

  • wait_for_completion boolean

    Should this request wait until the operation has completed before returning.

  • delete_user_annotations 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.

Responses

  • 200 application/json
    details#setActive"> Hide response attribute Show response attribute object
    • acknowledged boolean Required

      For a successful response, this value is always true. On failure, an exception is returned instead.
POST /_ml/anomaly_detectors/{job_id}/_reset
dropdown#toggle click@window->dropdown#hide touchend@window->dropdown#hide" data-dropdown-target="button" data-scrollable="false" data-headings="false" aria-expanded="false" aria-haspopup="true" role="menu" tabindex="0">
Console 
POST _ml/anomaly_detectors/total-requests/_reset

resp = client.ml.reset_job(
    job_id="total-requests",
)
const response = await client.ml.resetJob({
  job_id: "total-requests",
});
response = client.ml.reset_job(
  job_id: "total-requests"
)
$resp = $client->ml()->resetJob([
    "job_id" => "total-requests",
]);
curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_ml/anomaly_detectors/total-requests/_reset"
client.ml().resetJob(r -> r
    .jobId("total-requests")
);