Stop datafeeds Generally available; Added in 5.4.0

POST /_ml/datafeeds/{datafeed_id}/_stop
Api key auth Basic auth Bearer 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 authorization

  • 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

    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

    If true, the datafeed is stopped forcefully.

  • timeout string

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

    External documentation
application/json

Body

  • allow_no_match boolean

    Refer to the description for the allow_no_match query parameter.

    Default value is true.

  • force boolean

    Refer to the description for the force query parameter.

    Default value is false.

  • timeout string

    Refer to the description for the timeout query parameter.

    External documentation

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • stopped boolean Required
POST /_ml/datafeeds/{datafeed_id}/_stop 
POST _ml/datafeeds/datafeed-low_request_rate/_stop
{
  "timeout": "30s"
}
resp = client.ml.stop_datafeed(
    datafeed_id="datafeed-low_request_rate",
    timeout="30s",
)
const response = await client.ml.stopDatafeed({
  datafeed_id: "datafeed-low_request_rate",
  timeout: "30s",
});
response = client.ml.stop_datafeed(
  datafeed_id: "datafeed-low_request_rate",
  body: {
    "timeout": "30s"
  }
)
$resp = $client->ml()->stopDatafeed([
    "datafeed_id" => "datafeed-low_request_rate",
    "body" => [
        "timeout" => "30s",
    ],
]);
curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d '{"timeout":"30s"}' "$ELASTICSEARCH_URL/_ml/datafeeds/datafeed-low_request_rate/_stop"
Request example
An example body for a `POST _ml/datafeeds/datafeed-low_request_rate/_stop` request. 
{
  "timeout": "30s"
}