Delete data frame analytics jobs APIedit

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.

Requestedit

DELETE _ml/data_frame/analytics/<data_frame_analytics_id>

Prerequisitesedit

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

  • machine_learning_admin

For more information, see Built-in roles and Machine learning security privileges.

Path parametersedit

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

Query parametersedit

force
(Optional, boolean) If true, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.
timeout
(Optional, time units) The time to wait for the job to be deleted. Defaults to 1 minute.

Examplesedit

The following example deletes the loganalytics data frame analytics job:

DELETE _ml/data_frame/analytics/loganalytics

The API returns the following result:

{
  "acknowledged" : true
}