Delete data frame analytics jobs API

Delete data frame analytics jobs API

Deletes an existing data frame analytics job.

Request

DELETE _ml/data_frame/analytics/<data_frame_analytics_id>

Prerequisites

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

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.

timeout

(Optional, time units) The time to wait for the job to be deleted. Defaults to 1 minute.

Examples

The following example deletes the loganalytics data frame analytics job:

  1. DELETE _ml/data_frame/analytics/loganalytics

The API returns the following result:

  1. {
  2. "acknowledged" : true
  3. }