Stop datafeeds

POST /_ml/datafeeds/{datafeed_id}/_stop

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 Id 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

Request

Response

application/json

Examples

An example body for a POST _ml/datafeeds/datafeed-low_request_rate/_stop request.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST _ml/datafeeds/datafeed-low_request_rate/_stop
{
  "timeout": "30s"
}

JavaScript Elasticsearch JavaScript Client

const response = await client.ml.stopDatafeed({
  datafeed_id: "datafeed-low_request_rate",
  timeout: "30s",
});

Python Elasticsearch Python Client

resp = client.ml.stop_datafeed(
    datafeed_id="datafeed-low_request_rate",
    timeout="30s",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_ml/datafeeds/datafeed-low_request_rate/_stop" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "timeout": "30s"
  }'

Java Elasticsearch Java Client

client.ml().stopDatafeed(s -> s
    .datafeedId("datafeed-low_request_rate")
    .timeout(t -> t
        .time("30s")
    )
);

C# Elasticsearch .NET Client

var response = await client.MachineLearning
    .StopDatafeedAsync(datafeedId: "datafeed-low_request_rate", d1 => d1
        .Timeout("30s")
    );

PHP Elasticsearch PHP Client

$resp = $client->ml()->stopDatafeed([
    "datafeed_id" => "datafeed-low_request_rate",
    "body" => [
        "timeout" => "30s",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.ml.stop_datafeed(
  datafeed_id: "datafeed-low_request_rate",
  body: {
    "timeout": "30s"
  }
)

Response

No example

Required authorization

Path Parameters

Query Parameters { allow_no_match , force , timeout , close_job , }

Request { allow_no_match , force , timeout , close_job , }

Response

Query Parameters

Request