Get Datafeeds

The get datafeeds API enables you to retrieve configuration information for datafeeds.

Request

GET _xpack/ml/datafeeds/<feed_id>

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

GET _xpack/ml/datafeeds/

GET _xpack/ml/datafeeds/_all

Description

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 Parameters

feed_id
(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.

Results

The API returns the following information:

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

Authorization

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

Examples

The following example gets configuration information for the datafeed-it-ops-kpi datafeed:

GET _xpack/ml/datafeeds/datafeed-it-ops-kpi

The API returns the following results:

{
  "count": 1,
  "datafeeds": [
    {
      "datafeed_id": "datafeed-it-ops-kpi",
      "job_id": "it-ops-kpi",
      "query_delay": "60s",
      "frequency": "150s",
      "indices": [
        "it_ops_metrics"
      ],
      "types": [
        "kpi",
        "network",
        "sql"
      ],
      "query": {
        "match_all": {
          "boost": 1
        }
      },
      "scroll_size": 1000,
      "chunking_config": {
        "mode": "auto"
      }
    }
  ]
}