kibana/docs/api/logstash-configuration-management/list-pipeline.asciidoc
Mashhur 716609ef9e
Add a note that if list pipelines exceeds 10k, Kibana faces performan… (#131992)
* Add a note that if list pipelines exceeds 10k, Kibana faces performance issue. #131992
2022-05-11 16:24:16 -07:00

40 lines
1.1 KiB
Text

[[logstash-configuration-management-api-list]]
=== List Logstash pipeline API
++++
<titleabbrev>List pipeline</titleabbrev>
++++
experimental[] List all centrally-managed Logstash pipelines.
IMPORTANT: Limit the number of pipelines to 10k or fewer. As the number of pipelines nears and surpasses 10k, you may see performance issues on {kib}.
[[logstash-configuration-management-api-list-request]]
==== Request
`GET <kibana host>:<port>/api/logstash/pipelines`
[[logstash-configuration-management-api-list-example]]
==== Example
The API returns the following:
[source,sh]
--------------------------------------------------
{
"pipelines": [
{
"id": "hello-world",
"description": "Just a simple pipeline",
"last_modified": "2018-04-14T12:23:29.772Z",
"username": "elastic" <1>
},
{
"id": "sleepy-pipeline",
"description": "",
"last_modified": "2018-03-24T03:41:30.554Z"
}
]
}
--------------------------------------------------
<1> The `username` property appears when security is enabled, and depends on when the pipeline was created or last updated.