Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kibana streams API

Streams provide a unified data management layer for ingestion, routing, and processing. There are three stream types:* **Wired** streams are managed by Kibana. They route documents to child streams based on field conditions and support custom field mappings and processing steps.* **Classic** streams map to existing Elasticsearch data streams. You can add processing steps to classic streams without changing their underlying index template.* **Query** streams are virtual aggregations backed by an ES|QL expression. They aggregate data from multiple streams into a single logical view without duplicating documents.

Kibana streams API is one of 60 APIs that Kibana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include streams. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 25 operations across 19 paths, and defines 17 schemas. It is described by OpenAPI 3.0.3.

Requests are made against a single base URL, https://{kibana_url}.

25 operations 19 paths 17 schemas 3 DELETE7 GET10 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
Base URL
https://localhost:5601/api
Authentication
API Key, HTTP Basic
Contact
Kibana Team
Resource Areas
1

Authentication & Security 2

Kibana streams API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiKeyAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • apiKeyAuth — These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64A…

Paths & Operations 25

Across 19 paths, the API surfaces 25 operations — 3 DELETE, 7 GET, 10 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

streams 25

Streams provide a unified data management layer for ingestion, routing, and processing. There are three stream types: Wired streams are managed by Kibana. They route documents to…

GET
/api/streams
Get stream list
get-streams body → 200
POST
/api/streams/_disable
Disable streams
post-streams-disable 1 param body
POST
/api/streams/_enable
Enable streams
post-streams-enable 1 param body
POST
/api/streams/_resync
Resync streams
post-streams-resync 1 param body
DELETE
/api/streams/{name}
Delete a stream
delete-streams-name 2 params body → 200
GET
/api/streams/{name}
Get a stream
get-streams-name 1 param body → 200
PUT
/api/streams/{name}
Create or update a stream
put-streams-name 2 params body → 200
POST
/api/streams/{name}/_fork
Fork a stream
post-streams-name-fork 2 params body → 200
GET
/api/streams/{name}/_ingest
Get ingest stream settings
get-streams-name-ingest 1 param body → 200
PUT
/api/streams/{name}/_ingest
Update ingest stream settings
put-streams-name-ingest 2 params body → 200
GET
/api/streams/{name}/_query
Get query stream settings
get-streams-name-query 1 param body → 200
PUT
/api/streams/{name}/_query
Upsert query stream settings
put-streams-name-query 2 params body → 200
POST
/api/streams/{name}/content/export
Export stream content
post-streams-name-content-export 2 params body → 200
POST
/api/streams/{name}/content/import
Import content into a stream
post-streams-name-content-import 2 params body → 200
GET
/api/streams/{name}/queries
Get stream queries
get-streams-name-queries 1 param body → 200
POST
/api/streams/{name}/queries/_bulk
Bulk update queries
post-streams-name-queries-bulk 2 params body → 200
DELETE
/api/streams/{name}/queries/{queryId}
Remove a query from a stream
delete-streams-name-queries-queryid 3 params body → 200
PUT
/api/streams/{name}/queries/{queryId}
Upsert a query to a stream
put-streams-name-queries-queryid 3 params body → 200
GET
/api/streams/{name}/significant_events
Read the significant events
get-streams-name-significant-events 6 params body → 200
POST
/api/streams/{name}/significant_events/_generate
Generate significant events
post-streams-name-significant-events-generate 6 params body → 200
POST
/api/streams/{name}/significant_events/_preview
Preview significant events
post-streams-name-significant-events-preview 5 params body → 200
GET
/api/streams/{streamName}/attachments
Get stream attachments
get-streams-streamname-attachments 4 params body → 200
POST
/api/streams/{streamName}/attachments/_bulk
Bulk update attachments
post-streams-streamname-attachments-bulk 2 params body → 200
DELETE
/api/streams/{streamName}/attachments/{attachmentType}/{attachmentId}
Unlink an attachment from a stream
delete-streams-streamname-attachments-attachmenttype-attachmentid 4 params body → 200
PUT
/api/streams/{streamName}/attachments/{attachmentType}/{attachmentId}
Link an attachment to a stream
put-streams-streamname-attachments-attachmenttype-attachmentid 4 params body → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Kibana_HTTP_APIs_WiredStreamUpsertRequest (4 properties), Kibana_HTTP_APIs_QueryStreamUpsertRequest (4 properties), Kibana_HTTP_APIs_ClassicStreamUpsertRequest (4 properties), Kibana_HTTP_APIs_StreamlangConditionBlock (2 properties). Each schema is shown below with its type and property counts.

Kibana_HTTP_APIs_FailureStore
Kibana_HTTP_APIs_ClassicStreamUpsertRequest
object
4 properties 4 required
Kibana_HTTP_APIs_StreamUpsertRequest
Kibana_HTTP_APIs_StreamlangConditionBlock
object
2 properties 1 required
Kibana_HTTP_APIs_StreamlangStep
Kibana_HTTP_APIs_ClassicFieldDefinition
object
Kibana_HTTP_APIs_FilterCondition
A basic filter condition, either unary or binary.
Kibana_HTTP_APIs_FieldDefinition
object
Kibana_HTTP_APIs_FieldDefinitionConfig
Kibana_HTTP_APIs_ConditionWithSteps
Kibana_HTTP_APIs_WiredStreamUpsertRequest
object
4 properties 4 required
Kibana_HTTP_APIs_ClassicFieldDefinitionConfig
Kibana_HTTP_APIs_Condition
The root condition object. It can be a simple filter or a combination of other conditions.
Kibana_HTTP_APIs_RecursiveRecord
object
Kibana_HTTP_APIs_IngestStreamLifecycle
Kibana_HTTP_APIs_QueryStreamUpsertRequest
object
4 properties 4 required
Kibana_HTTP_APIs_ContentPackIncludedObjects

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kibana-streams-api-openapi.yml Raw ↑

Other APIs Kibana publishes across the network.

Kibana Actions API
Kibana agent builder API
Kibana alerting API
Kibana APM agent configuration API
Kibana APM agent keys API
Kibana APM annotations API
Kibana APM server schema API
Kibana APM sourcemaps API
Kibana cases API
Kibana connectors API
Kibana Data streams API
Kibana data views API