How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Stack (ELK Stack) Streams API

The streams API from Elastic Stack (ELK Stack) — 16 operation(s) for streams.

Elastic Stack (ELK Stack) Streams API is one of 132 APIs that Elastic Stack (ELK Stack) 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 an API reference.

This API exposes 21 operations across 16 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0.

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

21 operations 16 paths 21 schemas 2 DELETE6 GET9 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://{elasticsearch_endpoint}
Authentication
API Key, HTTP Basic
Resource Areas
1

Authentication & Security 2

Elastic Stack (ELK Stack) 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).

  • 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 21

Across 16 paths, the API surfaces 21 operations — 2 DELETE, 6 GET, 9 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

streams 21
POST
/_streams/{name}/_disable
Disable a named stream
streams-logs-disable 3 params → 200
POST
/_streams/{name}/_enable
Enable a named stream
streams-logs-enable 3 params → 200
GET
/_streams/status
Get the status of streams
streams-status 1 param → 200
GET
/api/streams
Get stream list
get-streams body → 200
POST
/api/streams/_disable
Disable streams
post-streams-disable 1 param body → 200
POST
/api/streams/_enable
Enable streams
post-streams-enable 1 param body → 200
POST
/api/streams/_resync
Resync streams
post-streams-resync 1 param body → 200
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/{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 21

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

streams._types.StreamType
string
_types.AcknowledgedResponseBase
object
1 property 1 required
streams.status.StreamStatus
object
1 property 1 required
_types.Duration
A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indica…
Kibana_HTTP_APIs_ClassicStreamUpsertRequest
object
3 properties 3 required
Kibana_HTTP_APIs_StreamlangStep
Kibana_HTTP_APIs_QueryStreamUpsertRequest
object
3 properties 3 required
Kibana_HTTP_APIs_RecursiveRecord
object
Kibana_HTTP_APIs_ClassicFieldDefinitionConfig
Kibana_HTTP_APIs_ConditionWithSteps
Kibana_HTTP_APIs_ContentPackIncludedObjects
Kibana_HTTP_APIs_FailureStore
Kibana_HTTP_APIs_StreamUpsertRequest
Kibana_HTTP_APIs_WiredStreamUpsertRequest
object
3 properties 3 required
Kibana_HTTP_APIs_IngestStreamLifecycle
Kibana_HTTP_APIs_ClassicFieldDefinition
object
Kibana_HTTP_APIs_StreamlangConditionBlock
object
2 properties 1 required
Kibana_HTTP_APIs_FieldDefinition
object
Kibana_HTTP_APIs_Condition
The root condition object. It can be a simple filter or a combination of other conditions.
Kibana_HTTP_APIs_FilterCondition
A basic filter condition, either unary or binary.
Kibana_HTTP_APIs_FieldDefinitionConfig

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elk-stack-streams-api-openapi.yml Raw ↑

Other APIs Elastic Stack (ELK Stack) publishes across the network.

Elastic Cloud API
Elastic Stack (ELK Stack) Accounts API
Elastic Stack (ELK Stack) Actions API
Elastic Stack (ELK Stack) agent builder API
Elastic Stack (ELK Stack) Alerting API
Elastic Stack (ELK Stack) Alerting V2 API
Elastic Stack (ELK Stack) Analytics API
Elastic Stack (ELK Stack) APM agent configuration API
Elastic Stack (ELK Stack) APM agent keys API
Elastic Stack (ELK Stack) APM annotations API
Elastic Stack (ELK Stack) APM server schema API
Elastic Stack (ELK Stack) APM sourcemaps API
Where this information came from

This is an independent, third-party profile of Elastic Stack (ELK Stack) Streams API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.