kibana/docs/api/logstash-configuration-management/retrieve-pipeline.asciidoc
Kaarina Tungseth fda3196611
[DOCS] Updates API requests and examples (#60695)
* [DOCS] Updates API requests and examples

* Review comments
2020-03-20 16:33:20 -05:00

36 lines
878 B
Text

[[logstash-configuration-management-api-retrieve]]
=== Retrieve pipeline API
++++
<titleabbrev>Retrieve pipeline</titleabbrev>
++++
experimental[] Retrieve a centrally-managed Logstash pipeline.
[[logstash-configuration-management-api-retrieve-request]]
==== Request
`GET <kibana host>:<port>/api/logstash/pipeline/<id>`
[[logstash-configuration-management-api-retrieve-path-params]]
==== Path parameters
`id`::
(Required, string) The pipeline ID.
[[logstash-configuration-management-api-retrieve-example]]
==== Example
The API returns the following:
[source,sh]
--------------------------------------------------
{
"id": "hello-world",
"description": "Just a simple pipeline",
"username": "elastic",
"pipeline": "input { stdin {} } output { stdout {} }",
"settings": {
"queue.type": "persistent"
}
}
--------------------------------------------------