Get Datafeeds APIedit

Retrieves configuration information for datafeeds.


GET _xpack/ml/datafeeds/<feed_id>

GET _xpack/ml/datafeeds/<feed_id>,<feed_id>

GET _xpack/ml/datafeeds/

GET _xpack/ml/datafeeds/_all


You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get information for all datafeeds by using _all, by specifying * as the <feed_id>, or by omitting the <feed_id>.

Path Parametersedit

(string) Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the API returns information about all datafeeds.

Query parametersedit


(Optional, 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.

The default value is true, which returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.


The API returns the following information:

(array) An array of datafeed objects. For more information, see Datafeed Resources.

Response codesedit

404 (Missing resources)
If allow_no_datafeeds is false, this code indicates that there are no resources that match the request or only partial matches for the request.


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


The following example gets configuration information for the datafeed-total-requests datafeed:

GET _xpack/ml/datafeeds/datafeed-total-requests

The API returns the following results:

  "count": 1,
  "datafeeds": [
      "datafeed_id": "datafeed-total-requests",
      "job_id": "total-requests",
      "query_delay": "83474ms",
      "indices": [
      "types": [],
      "query": {
        "match_all": {
          "boost": 1.0
      "scroll_size": 1000,
      "chunking_config": {
        "mode": "auto"