OpenSearch/docs/reference/ml/apis/get-datafeed.asciidoc

[role="xpack"]
[testenv="platinum"]
[[ml-get-datafeed]]
=== Get {dfeeds-cap} API
++++
<titleabbrev>Get {dfeeds-cap}</titleabbrev>
++++

Retrieves configuration information for {dfeeds}.

==== 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 {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
`<feed_id>`, or by omitting the `<feed_id>`.

==== 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 <<ml-datafeed-resource>>.


==== 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-total-requests` {dfeed}:

[source,js]
--------------------------------------------------
GET _xpack/ml/datafeeds/datafeed-total-requests
--------------------------------------------------
// CONSOLE
// TEST[skip:setup:server_metrics_datafeed]

The API returns the following results:
[source,js]
----
{
  "count": 1,
  "datafeeds": [
    {
      "datafeed_id": "datafeed-total-requests",
      "job_id": "total-requests",
      "query_delay": "83474ms",
      "indices": [
        "server-metrics"
      ],
      "types": [],
      "query": {
        "match_all": {
          "boost": 1.0
        }
      },
      "scroll_size": 1000,
      "chunking_config": {
        "mode": "auto"
      }
    }
  ]
}
----
// TESTRESPONSE[s/"query.boost": "1.0"/"query.boost": $body.query.boost/]