GET /api/fleet/data_streams
Api key auth

Spaces method and path for this operation:

get /s/{space_id}/api/fleet/data_streams

Refer to Spaces for more information.

List all Fleet-managed data streams with metadata including package, namespace, size, and last activity.

[Required authorization] Route required privileges: fleet-agents-all AND fleet-agent-policies-all AND fleet-settings-all.

Responses

  • 200 application/json

    Successful response

    Hide response attribute Show response attribute object
    • data_streams array[object] Required

      Not more than 10000 elements.

      Hide data_streams attributes Show data_streams attributes object
      • dashboards array[object] Required

        Not more than 10000 elements.

        Hide dashboards attributes Show dashboards attributes object
        • id string Required
        • title string Required
      • dataset string Required
      • index string Required
      • last_activity_ms number Required
      • namespace string Required
      • package string Required
      • package_version string Required
      • serviceDetails object | null Required

        Additional properties are NOT allowed.

        Hide serviceDetails attributes Show serviceDetails attributes object | null
        • environment string Required
        • serviceName string Required
      • size_in_bytes number Required

      • size_in_bytes_formatted number | string Required

        Any of:
        number-1 number string-2 string
      • type string Required
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • attributes Required
    • error string
    • errorType string
    • message string Required
    • statusCode number
GET /api/fleet/data_streams 
curl \
 --request GET 'https://<KIBANA_URL>/api/fleet/data_streams' \
 --header "Authorization: $API_KEY"
Response examples (200)
List of Fleet-managed data streams 
{
  "data_streams": [
    {
      "dashboards": [
        {
          "id": "nginx-overview",
          "title": "Nginx Overview"
        }
      ],
      "dataset": "nginx.access",
      "index": "logs-nginx.access-default",
      "last_activity_ms": 1700000000000,
      "namespace": "default",
      "package": "nginx",
      "package_version": "1.20.0",
      "serviceDetails": null,
      "size_in_bytes": 1048576,
      "size_in_bytes_formatted": "1mb",
      "type": "logs"
    },
    {
      "dashboards": [],
      "dataset": "system.cpu",
      "index": "metrics-system.cpu-default",
      "last_activity_ms": 1699999000000,
      "namespace": "default",
      "package": "system",
      "package_version": "1.38.0",
      "serviceDetails": null,
      "size_in_bytes": 524288,
      "size_in_bytes_formatted": "512kb",
      "type": "metrics"
    }
  ]
}
Response examples (400)
Example of a generic error response 
{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}