WARNING: Version 5.6 of Elasticsearch has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Delete Datafeeds API Delete Model Snapshots API »

› › ›

Delete Jobs API

The delete job API enables you to delete an existing anomaly detection job.

Request

DELETE _xpack/ml/anomaly_detectors/<job_id>

Description

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

job_id (required): (string) Identifier for the job

Query Parameters

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

Authorization

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

Examples

The following example deletes the event_rate job:

DELETE _xpack/ml/anomaly_detectors/event_rate

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

{
  "acknowledged": true
}

« Delete Datafeeds API Delete Model Snapshots API »