Delete data frame analytics jobs API

Deletes an existing data frame analytics job.

This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features.

Request

DELETE _ml/data_frame/analytics/<data_frame_analytics_id>

Prerequisites

If the Elasticsearch security features are enabled, you must have the following built-in roles or equivalent privileges:

  • machine_learning_admin
  • kibana_admin (UI only)

For more information, see Security privileges and Built-in roles.

Path parameters

<data_frame_analytics_id>
(Required, string) Identifier for the data frame analytics job.

Query parameters

force
(Optional, boolean) If true, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.

Examples

The following example deletes the loganalytics data frame analytics job:

DELETE _ml/data_frame/analytics/loganalytics

The API returns the following result:

{
  "acknowledged" : true
}