OpenSearch/docs/reference/ml/df-analytics/apis/delete-dfanalytics.asciidoc

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

Deletes an existing {dfanalytics-job}.

experimental[]

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

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

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

* You must have `machine_learning_admin` built-in role to use this API. For more 
information, see {stack-ov}/security-privileges.html[Security privileges] and 
{stack-ov}/built-in-roles.html[Built-in roles].

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

`<data_frame_analytics_id>`::
  (Required, string) Identifier for the {dfanalytics-job} you want to delete.

[[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
}
----