{ "opencollection": "1.0.0", "info": { "name": "Kibana APIs Actions streams API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "streams", "type": "folder" }, "items": [ { "info": { "name": "Get stream list", "type": "http" }, "http": { "method": "GET", "url": "https://{kibana_url}/api/streams", "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
get /s/{space_id}/api/streams
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nFetches list of all streams

[Required authorization] Route required privileges: read_stream." }, { "info": { "name": "Disable streams", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/streams/_disable", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/streams/_disable
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nDisables wired streams and deletes all existing stream definitions. The data of wired streams is deleted, but the data of classic streams is preserved.

[Required authorization] Route required privileges: manage_" }, { "info": { "name": "Enable streams", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/streams/_enable", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/streams/_enable
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nEnables wired streams

[Required authorization] Route required privileges: manage_stream." }, { "info": { "name": "Resync streams", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/streams/_resync", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/streams/_resync
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nResyncs all streams, making sure that Elasticsearch assets are up to date

[Required authorization] Route required privileges: manage_stream." }, { "info": { "name": "Get a stream", "type": "http" }, "http": { "method": "GET", "url": "https://{kibana_url}/api/streams/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the stream." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
get /s/{space_id}/api/streams/{name}
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nFetches a stream definition and associated dashboards

[Required authorization] Route required privileges: read_stream." }, { "info": { "name": "Create or update a stream", "type": "http" }, "http": { "method": "PUT", "url": "https://{kibana_url}/api/streams/:name", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the stream." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
put /s/{space_id}/api/streams/{name}
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nCreates or updates a stream definition. Classic streams can not be created through this API, only updated

[Required authorization] Route required privileges: manage_stream." }, { "info": { "name": "Delete a stream", "type": "http" }, "http": { "method": "DELETE", "url": "https://{kibana_url}/api/streams/:name", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the stream." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
delete /s/{space_id}/api/streams/{name}
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nDeletes a stream definition and the underlying data stream

[Required authorization] Route required privileges: manage_stream." }, { "info": { "name": "Fork a stream", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/streams/:name/_fork", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the parent stream to fork from." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/streams/{name}/_fork
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nForks a wired stream and creates a child stream

[Required authorization] Route required privileges: manage_stream." }, { "info": { "name": "Get ingest stream settings", "type": "http" }, "http": { "method": "GET", "url": "https://{kibana_url}/api/streams/:name/_ingest", "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the stream." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
get /s/{space_id}/api/streams/{name}/_ingest
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nFetches the ingest settings of an ingest stream definition

[Required authorization] Route required privileges: read_stream." }, { "info": { "name": "Update ingest stream settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{kibana_url}/api/streams/:name/_ingest", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the stream." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
put /s/{space_id}/api/streams/{name}/_ingest
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nUpserts the ingest settings of an ingest stream definition

[Required authorization] Route required privileges: manage_stream." }, { "info": { "name": "Get query stream settings", "type": "http" }, "http": { "method": "GET", "url": "https://{kibana_url}/api/streams/:name/_query", "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the query stream." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
get /s/{space_id}/api/streams/{name}/_query
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nFetches the query settings of a query stream definition

[Required authorization] Route required privileges: read_stream." }, { "info": { "name": "Upsert query stream settings", "type": "http" }, "http": { "method": "PUT", "url": "https://{kibana_url}/api/streams/:name/_query", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the query stream." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
put /s/{space_id}/api/streams/{name}/_query
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nUpserts the query settings of a query stream definition

[Required authorization] Route required privileges: manage_stream." }, { "info": { "name": "Export stream content", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/streams/:name/content/export", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the stream to export content from." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/streams/{name}/content/export
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nExports the content associated to a stream.

[Required authorization] Route required privileges: manage_stream." }, { "info": { "name": "Import content into a stream", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/streams/:name/content/import", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the stream to import content into." } ], "body": { "type": "multipart-form", "data": [ { "name": "content", "type": "text", "value": "" }, { "name": "include", "type": "text", "value": "" } ] } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/streams/{name}/content/import
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nLinks content objects to a stream.

[Required authorization] Route required privileges: manage_stream." }, { "info": { "name": "Get stream queries", "type": "http" }, "http": { "method": "GET", "url": "https://{kibana_url}/api/streams/:name/queries", "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the stream." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
get /s/{space_id}/api/streams/{name}/queries
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nFetches all queries linked to a stream that are visible to the current user in the current space.

[Required authorization] Route required privileges: read_stream." }, { "info": { "name": "Bulk update queries", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/streams/:name/queries/_bulk", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the stream." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/streams/{name}/queries/_bulk
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nBulk update queries of a stream. Can add new queries and delete existing ones.

[Required authorization] Route required privileges: manage_stream." }, { "info": { "name": "Upsert a query to a stream", "type": "http" }, "http": { "method": "PUT", "url": "https://{kibana_url}/api/streams/:name/queries/:queryId", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the stream." }, { "name": "queryId", "value": "", "type": "path", "description": "The identifier of the query." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
put /s/{space_id}/api/streams/{name}/queries/{queryId}
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nAdds a query to a stream. Noop if the query is already present on the stream.

[Required authorization] Route required privileges: manage_stream." }, { "info": { "name": "Remove a query from a stream", "type": "http" }, "http": { "method": "DELETE", "url": "https://{kibana_url}/api/streams/:name/queries/:queryId", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the stream." }, { "name": "queryId", "value": "", "type": "path", "description": "The identifier of the query to remove." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
delete /s/{space_id}/api/streams/{name}/queries/{queryId}
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nRemove a query from a stream. Noop if the query is not found on the stream.

[Required authorization] Route required privileges: manage_stream." }, { "info": { "name": "Read the significant events", "type": "http" }, "http": { "method": "GET", "url": "https://{kibana_url}/api/streams/:name/significant_events", "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the stream." }, { "name": "from", "value": "", "type": "query" }, { "name": "to", "value": "", "type": "query" }, { "name": "bucketSize", "value": "", "type": "query", "description": "The bucket size for aggregating events (e.g. \"1m\", \"1h\")." }, { "name": "query", "value": "", "type": "query", "description": "Query string to filter significant events on metadata fields" }, { "name": "searchMode", "value": "", "type": "query", "description": "Search mode: keyword (BM25), semantic (vector), or hybrid (RRF). When omitted, defaults to hybrid with a silent keyword fallback on failure. When set explicitly, failures propagate as errors." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
get /s/{space_id}/api/streams/{name}/significant_events
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nRead the significant events

[Required authorization] Route required privileges: read_stream." }, { "info": { "name": "Generate significant events", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/streams/:name/significant_events/_generate", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the stream." }, { "name": "connectorId", "value": "", "type": "query", "description": "Optional connector ID. If not provided, the default AI connector from settings will be used." }, { "name": "from", "value": "", "type": "query" }, { "name": "to", "value": "", "type": "query" }, { "name": "sampleDocsSize", "value": "", "type": "query", "description": "Number of sample documents to use for generation from the current data of stream" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/streams/{name}/significant_events/_generate
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nGenerate significant events queries based on the stream data

[Required authorization] Route required privileges: read_stream." }, { "info": { "name": "Preview significant events", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/streams/:name/significant_events/_preview", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "name", "value": "", "type": "path", "description": "The name of the stream." }, { "name": "from", "value": "", "type": "query" }, { "name": "to", "value": "", "type": "query" }, { "name": "bucketSize", "value": "", "type": "query", "description": "The bucket size for aggregating events (e.g. \"1m\", \"1h\")." } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/streams/{name}/significant_events/_preview
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nPreview significant event results based on a given query

[Required authorization] Route required privileges: read_stream." }, { "info": { "name": "Get stream attachments", "type": "http" }, "http": { "method": "GET", "url": "https://{kibana_url}/api/streams/:streamName/attachments", "params": [ { "name": "streamName", "value": "", "type": "path", "description": "The name of the stream" }, { "name": "query", "value": "", "type": "query", "description": "Search query to filter attachments by title" }, { "name": "attachmentTypes", "value": "", "type": "query", "description": "Filter by attachment types (single value or array)" }, { "name": "tags", "value": "", "type": "query", "description": "Filter by tags (single value or array)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
get /s/{space_id}/api/streams/{streamName}/attachments
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nFetches all attachments linked to a stream that are visible to the current user in the current space. Optionally filter by attachment types, search query, and tags.

[Required authorization] Route r" }, { "info": { "name": "Bulk update attachments", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/streams/:streamName/attachments/_bulk", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "streamName", "value": "", "type": "path", "description": "The name of the stream" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
post /s/{space_id}/api/streams/{streamName}/attachments/_bulk
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nBulk update attachments linked to a stream. Can link new attachments and delete existing ones. Supports mixed attachment types in a single request.

[Required authorization] Route required p" }, { "info": { "name": "Link an attachment to a stream", "type": "http" }, "http": { "method": "PUT", "url": "https://{kibana_url}/api/streams/:streamName/attachments/:attachmentType/:attachmentId", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "streamName", "value": "", "type": "path", "description": "The name of the stream" }, { "name": "attachmentType", "value": "", "type": "path", "description": "The type of the attachment" }, { "name": "attachmentId", "value": "", "type": "path", "description": "The ID of the attachment" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
put /s/{space_id}/api/streams/{streamName}/attachments/{attachmentType}/{attachmentId}
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nLinks an attachment to a stream. Noop if the attachment is already linked to the stream.

[Required authorization] Route required privileges: manage_stream." }, { "info": { "name": "Unlink an attachment from a stream", "type": "http" }, "http": { "method": "DELETE", "url": "https://{kibana_url}/api/streams/:streamName/attachments/:attachmentType/:attachmentId", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "streamName", "value": "", "type": "path", "description": "The name of the stream" }, { "name": "attachmentType", "value": "", "type": "path", "description": "The type of the attachment" }, { "name": "attachmentId", "value": "", "type": "path", "description": "The ID of the attachment" } ], "body": { "type": "json", "data": "{}" } }, "docs": "**Spaces method and path for this operation:**\n\n
delete /s/{space_id}/api/streams/{streamName}/attachments/{attachmentType}/{attachmentId}
\n\nRefer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.\n\nUnlinks an attachment from a stream. Noop if the attachment is not linked to the stream.

[Required authorization] Route required privileges: manage_stream." } ] } ], "bundled": true }