Stop datafeeds

Auth

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

Required privileges

Cluster privileges manage_ml

Path parameters

datafeed_id string required

Identifier for the datafeed. 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 identifier.

Query parameters

allow_no_match boolean · default: true

Specifies what to do when the request:

  • Contains wildcard expressions and there are no datafeeds that match.
  • Contains the _all string or no identifiers and there are no matches.
  • Contains wildcard expressions and there are only partial matches.

If true, the API returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If false, the API returns a 404 status code when there are no matches or only partial matches.

force boolean · default: false

If true, the datafeed is stopped forcefully.

timeout string · default: 20s

Specifies the amount of time to wait until a datafeed stops.

close_job boolean · default: false

If true the job associated with the datafeed is closed.

Request body

allow_no_match boolean · default: true

Refer to the description for the allow_no_match query parameter.

force boolean · default: false

Refer to the description for the force query parameter.

timeout string · default: 20s

Refer to the description for the timeout query parameter.

close_job boolean · default: false

Refer to the description for the close_job query parameter.

Response

application/json
stopped boolean required