Stop data frame analytics jobs APIedit

Stops one or more data frame analytics jobs.

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


POST _ml/data_frame/analytics/<data_frame_analytics_id>/_stop

POST _ml/data_frame/analytics/<data_frame_analytics_id>,<data_frame_analytics_id>/_stop

POST _ml/data_frame/analytics/_all/_stop



A data frame analytics job can be started and stopped multiple times throughout its lifecycle.

You can stop multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression. You can stop all data frame analytics job by using _all or by specifying * as the <data_frame_analytics_id>.

Path parametersedit

(Required, string) Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.

Query parametersedit

(Optional, boolean) If false and the data_frame_analytics_id does not match any data frame analytics job an error will be returned. The default value is true.
(Optional, boolean) If true, the data frame analytics job is stopped forcefully.
(Optional, time) Controls the amount of time to wait until the data frame analytics job stops. The default value is 20 seconds.


The following example stops the loganalytics data frame analytics job:

POST _ml/data_frame/analytics/loganalytics/_stop

When the data frame analytics job stops, you receive the following results:

  "stopped" : true