[role="xpack"]
[testenv="platinum"]
[[delete-dfanalytics]]
= Delete {dfanalytics-jobs} API
[subs="attributes"]
++++
<titleabbrev>Delete {dfanalytics-jobs}</titleabbrev>
++++

Deletes an existing {dfanalytics-job}.

beta::[]


[[ml-delete-dfanalytics-request]]
== {api-request-title}

`DELETE _ml/data_frame/analytics/<data_frame_analytics_id>`


[[ml-delete-dfanalytics-prereq]]
== {api-prereq-title}

If the {es} {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 {ml-docs-setup-privileges}.


[[ml-delete-dfanalytics-path-params]]
== {api-path-parms-title}

`<data_frame_analytics_id>`::
(Required, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics]

[[ml-delete-dfanalytics-query-params]]
== {api-query-parms-title}

`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,time units>>) The time to wait for the job to be deleted.
  Defaults to 1 minute.



[[ml-delete-dfanalytics-example]]
== {api-examples-title}

The following example deletes the `loganalytics` {dfanalytics-job}:

[source,console]
--------------------------------------------------
DELETE _ml/data_frame/analytics/loganalytics
--------------------------------------------------
// TEST[skip:TBD]

The API returns the following result:

[source,console-result]
----
{
  "acknowledged" : true
}
----
