- X-Pack Reference for 6.0-6.2 and 5.x:
- Introduction
- Installing X-Pack
- Migrating to X-Pack
- Breaking Changes
- Securing Elasticsearch and Kibana
- Monitoring the Elastic Stack
- Alerting on Cluster and Index Events
- Reporting from Kibana
- Graphing Connections in Your Data
- Profiling your Queries and Aggregations
- Machine Learning in the Elastic Stack
- X-Pack Settings
- X-Pack APIs
- Info API
- Security APIs
- Watcher APIs
- Graph APIs
- Machine Learning APIs
- Close Jobs
- Create Datafeeds
- Create Jobs
- Delete Datafeeds
- Delete Jobs
- Delete Model Snapshots
- Flush Jobs
- Get Buckets
- Get Categories
- Get Datafeeds
- Get Datafeed Statistics
- Get Influencers
- Get Jobs
- Get Job Statistics
- Get Model Snapshots
- Get Records
- Open Jobs
- Post Data to Jobs
- Preview Datafeeds
- Revert Model Snapshots
- Start Datafeeds
- Stop Datafeeds
- Update Datafeeds
- Update Jobs
- Update Model Snapshots
- Validate Detectors
- Validate Jobs
- Definitions
- Troubleshooting
- Limitations
- License Management
- Release Notes
WARNING: Version 5.4 of the Elastic Stack 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.
Stop Datafeeds
editStop Datafeeds
editA datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle.
Request
editPOST _xpack/ml/datafeeds/<feed_id>/_stop
Path Parameters
edit-
feed_id(required) - (string) Identifier for the datafeed
Request Body
edit-
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
editYou must have manage_ml, or manage cluster privileges to use this API.
For more information, see Cluster Privileges.
Examples
editThe 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 }
Was this helpful?
Thank you for your feedback.