[role="xpack"]
[[ml-get-datafeed]]
=== Get {dfeeds-cap} API
++++
Get {dfeeds-cap}
++++
This API enables you to retrieve configuration information for {dfeeds}.
==== Request
`GET _xpack/ml/datafeeds/` +
`GET _xpack/ml/datafeeds/,` +
`GET _xpack/ml/datafeeds/` +
`GET _xpack/ml/datafeeds/_all` +
===== Description
You can get information for multiple {dfeeds} in a single API request by using a
comma-separated list of {dfeeds} or a wildcard expression. You can get
information for all {dfeeds} by using `_all`, by specifying `*` as the
``, or by omitting the ``.
==== Path Parameters
`feed_id`::
(string) Identifier for the {dfeed}. It can be a {dfeed} identifier or a
wildcard expression. If you do not specify one of these options, the API
returns information about all {dfeeds}.
==== Results
The API returns the following information:
`datafeeds`::
(array) An array of {dfeed} objects.
For more information, see <>.
==== Authorization
You must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster
privileges to use this API. For more information, see
{xpack-ref}/security-privileges.html[Security Privileges].
==== Examples
The following example gets configuration information for the
`datafeed-it-ops-kpi` {dfeed}:
[source,js]
--------------------------------------------------
GET _xpack/ml/datafeeds/datafeed-it-ops-kpi
--------------------------------------------------
// CONSOLE
// TEST[skip:todo]
The API returns the following results:
[source,js]
----
{
"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"
}
}
]
}
----