Get data streams

Base URL: https://{kibana_url}

GET /api/fleet/epm/data_streams
GET /s/{space_id}/api/fleet/epm/data_streams

Auth

Get a list of data streams created by installed integration packages.

Required privileges

Privileges integrations-read or fleet-setup or fleet-all

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Query parameters

type enum: Filter by data stream type; Values: logs metrics traces synthetics profiles
datasetQuery string: Filter data streams by dataset name
sortOrder enum · default: asc: Sort order, ascending or descending; Values: asc desc
uncategorisedOnly boolean · default: false: When true, only return data streams that are not associated with a package

Responses

Successful response

application/json

items object[] · max items: 10000 required

Bad Request

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/epm/data_streams

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/fleet/epm/data_streams" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

List of data streams from installed packages

{
  "data_streams": [
    {
      "ilm_policy": "logs-default",
      "index_template": "logs-system.syslog",
      "name": "logs-system.syslog-default",
      "package": "system",
      "package_version": "1.55.0",
      "title": "System syslog logs"
    }
  ]
}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}