IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Delete data frame analytics jobs APIedit
Deletes an existing data frame analytics job.
This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta 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
}