--
:api: stop-data-frame-analytics
:request: StopDataFrameAnalyticsRequest
:response: StopDataFrameAnalyticsResponse
--
[role="xpack"]
[id="{upid}-{api}"]
=== Stop {dfanalytics} API

The stop {dfanalytics} API is used to stop a running {dataframe-analytics-config}.
It accepts a +{request}+ object and responds with a +{response}+ object.

[id="{upid}-{api}-request"]
==== Stop {dfanalytics} Request

A +{request}+ object requires a {dataframe-analytics-config} id.

["source","java",subs="attributes,callouts,macros"]
---------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
---------------------------------------------------
<1> Constructing a new stop request referencing an existing {dataframe-analytics-config}
<2> Optionally used to stop a failed task

include::../execution.asciidoc[]

[id="{upid}-{api}-response"]
==== Response

The returned +{response}+ object acknowledges the {dfanalytics-job} has stopped.