Delete data frame analytics jobs APIedit

Deletes an existing data frame analytics job.

Requestedit

DELETE _ml/data_frame/analytics/<data_frame_analytics_id>

Prerequisitesedit

Requires the manage_ml cluster privilege. This privilege is included in the machine_learning_admin built-in role.

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:

response = client.ml.delete_data_frame_analytics(
  id: 'loganalytics'
)
puts response
DELETE _ml/data_frame/analytics/loganalytics

The API returns the following result:

{
  "acknowledged" : true
}