IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Create inference trained model API Delete inference trained model API »
Elastic Docs ›Elasticsearch Guide [7.6] ›REST APIs ›Machine learning data frame analytics APIs

Delete data frame analytics jobs API

edit

Delete data frame analytics jobs API

edit

Deletes an existing data frame analytics job.

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

Request

edit

DELETE _ml/data_frame/analytics/<data_frame_analytics_id>

Prerequisites

edit

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

  • machine_learning_admin
  • kibana_user (UI only)

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

Path parameters

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

Query parameters

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

Examples

edit

The following example deletes the loganalytics data frame analytics job:

DELETE _ml/data_frame/analytics/loganalytics

The API returns the following result:

{
  "acknowledged" : true
}
« Create inference trained model API Delete inference trained model API »