Stops one or more datafeeds.
A datafeed that is stopped ceases to retrieve data from Elasticsearch.
A datafeed can be started and stopped multiple times throughout its lifecycle.
POST _ml/datafeeds/<feed_id>/_stop
POST _ml/datafeeds/<feed_id>,<feed_id>/_stop
POST _ml/datafeeds/_all/_stop
You can stop multiple datafeeds in a single API request by using a
comma-separated list of datafeeds or a wildcard expression. You can close all
datafeeds by using _all or by specifying * as the <feed_id>.
-
feed_id
-
(string) Identifier for the datafeed. It can be a datafeed identifier or a
wildcard expression.
-
force
-
(boolean) If true, the datafeed is stopped forcefully.
-
timeout
-
(time) Controls the amount of time to wait until a datafeed stops.
The default value is 20 seconds.
You must have manage_ml, or manage cluster privileges to use this API.
For more information, see
Security Privileges.
The following example stops the datafeed-total-requests datafeed:
POST _ml/datafeeds/datafeed-total-requests/_stop
{
"timeout": "30s"
}When the datafeed stops, you receive the following results: