› › ›

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:

resp = client.ml.delete_data_frame_analytics(
    id="loganalytics",
)
print(resp)

response = client.ml.delete_data_frame_analytics(
  id: 'loganalytics'
)
puts response

const response = await client.ml.deleteDataFrameAnalytics({
  id: "loganalytics",
});
console.log(response);

DELETE _ml/data_frame/analytics/loganalytics

The API returns the following result:

{
  "acknowledged" : true
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-dfanalytics.html