Stop Datafeeds API

WARNING: Version 5.6 of Elasticsearch has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

› › ›

« Start Datafeeds API Update Datafeeds API »

A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle.

Request

POST _xpack/ml/datafeeds/<feed_id>/_stop

Path Parameters

feed_id (required): (string) Identifier for the datafeed

Request Body

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.

Authorization

You must have manage_ml, or manage cluster privileges to use this API. For more information, see Security Privileges.

Examples

The following example stops the datafeed-it-ops-kpi datafeed:

POST _xpack/ml/datafeeds/datafeed-it-ops-kpi/_stop
{
  "timeout": "30s"
}

When the datafeed stops, you receive the following results:

{
  "stopped": true
}

« Start Datafeeds API Update Datafeeds API »