Get a stream

Base URL: https://{kibana_url}

GET /api/streams/{name}
GET /s/{space_id}/api/streams/{name}

Auth

Fetches a stream definition and associated dashboards

Required privileges

Privileges read_stream

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.
name string · max length: 200 required: The name of the stream.

Request body

Any of:

Response

200

Stream definition and associated metadata.

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/streams/NAME
{}

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/streams/${NAME}" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{}'

Generated from the API spec

Response

{
  "dashboards": [],
  "data_stream_exists": true,
  "effective_failure_store": {
    "disabled": {},
    "from": "logs"
  },
  "effective_lifecycle": {
    "dsl": {
      "data_retention": "7d"
    },
    "from": "logs"
  },
  "effective_settings": {},
  "inherited_fields": {
    "@timestamp": {
      "from": "logs",
      "type": "date"
    },
    "log.level": {
      "from": "logs",
      "type": "keyword"
    }
  },
  "privileges": {
    "create_snapshot_repository": false,
    "lifecycle": true,
    "manage": true,
    "manage_failure_store": true,
    "monitor": true,
    "read_failure_store": true,
    "simulate": true,
    "text_structure": true,
    "view_index_metadata": true
  },
  "rules": [],
  "stream": {
    "description": "Web server access logs, routed by severity",
    "ingest": {
      "failure_store": {
        "inherit": {}
      },
      "lifecycle": {
        "inherit": {}
      },
      "processing": {
        "steps": [],
        "updated_at": "2025-01-15T10:30:00.000Z"
      },
      "settings": {},
      "wired": {
        "fields": {
          "host.name": {
            "type": "keyword"
          },
          "http.response.status_code": {
            "type": "long"
          },
          "message": {
            "type": "match_only_text"
          }
        },
        "routing": [
          {
            "destination": "logs.nginx.errors",
            "status": "enabled",
            "where": {
              "field": "http.response.status_code",
              "gte": 500
            }
          }
        ]
      }
    },
    "name": "logs.nginx",
    "type": "wired",
    "updated_at": "2025-01-15T10:30:00.000Z"
  }
}