Reset an anomaly detection job

POST /_ml/anomaly_detectors/{job_id}/_reset

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.

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 · default: true: Should this request wait until the operation has completed before returning.
delete_user_annotations boolean · default: false: Specifies whether annotations that have been added by the user should be deleted along with any auto-generated annotations when the job is reset.

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST _ml/anomaly_detectors/total-requests/_reset

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.resetJob({
  job_id: "total-requests",
});

Python Elasticsearch Python Client

resp = client.ml.reset_job(
    job_id="total-requests",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_ml/anomaly_detectors/total-requests/_reset" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ml().resetJob(r -> r
    .jobId("total-requests")
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning.ResetJobAsync(jobId: "total-requests");

PHP Elasticsearch PHP Client

$resp = $client->ml()->resetJob([
    "job_id" => "total-requests",
]);

Ruby Elasticsearch Ruby Client

response = client.ml.reset_job(
  job_id: "total-requests"
)

Response

{
  "acknowledged": false
}

Generated from the API spec