IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Delete Events from Calendar API Delete Jobs from Calendar API »

› › ›

Delete Jobs API

edit

Delete Jobs API

edit

Deletes an existing anomaly detection job.

Request

edit

DELETE _xpack/ml/anomaly_detectors/<job_id>

Description

edit

All job configuration, model state and results are deleted.

Deleting a 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 X-Pack security is 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 job

Query Parameters

edit

force: (boolean) Use to forcefully delete an opened job; this method is quicker than closing and deleting the job.

Authorization

edit

You must have manage_ml, or manage cluster privileges to use this API. For more information, see Security privileges.

Examples

edit

The following example deletes the total-requests job:

DELETE _xpack/ml/anomaly_detectors/total-requests

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

{
  "acknowledged": true
}

« Delete Events from Calendar API Delete Jobs from Calendar API »