Delete anomaly detection jobs API
editDelete anomaly detection jobs API
editDeletes an existing anomaly detection job.
Request
editDELETE _ml/anomaly_detectors/<job_id>
Description
editAll job configuration, model state and results are deleted.
Deleting an anomaly detection job must be done via this API only. Do not
delete the job directly from the .ml-* indices using the Elasticsearch delete document
API. When Elasticsearch security features are enabled, make sure no write privileges
are granted to anyone over the .ml-* indices.
Before you can delete a job, you must delete the datafeeds that are associated
with it. See Delete Datafeeds. Unless the force
parameter is used the job must be closed before it can be deleted.
It is not currently possible to delete 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-
force - (boolean) Use to forcefully delete an opened job; this method is quicker than closing and deleting the job.
-
wait_for_completion -
(boolean) Specifies whether the request should return immediately or wait
until the job deletion completes. Defaults to
true.
Prerequisites
editIf Elasticsearch security features are enabled, you must have manage_ml, or manage
cluster privileges to use this API.
For more information, see Security privileges.
Examples
editThe following example deletes the total-requests job:
DELETE _ml/anomaly_detectors/total-requests
When the job is deleted, you receive the following results:
{
"acknowledged": true
}
In the next example we delete the total-requests job asynchronously:
DELETE _ml/anomaly_detectors/total-requests?wait_for_completion=false
When wait_for_completion is set to false, the response contains the id
of the job deletion task:
{
"task": "oTUltX4IQMOUUVeiohTt8A:39"
}