44 lines
1 KiB
Text
44 lines
1 KiB
Text
[role="xpack"]
|
|
[[logstash-configuration-management-api-retrieve]]
|
|
=== Retrieve Pipeline
|
|
|
|
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
|
|
|
The Retrieve Pipeline API enables you to retrieve a centrally-managed Logstash pipeline.
|
|
|
|
Note: You cannot access this endpoint via the Console in Kibana.
|
|
|
|
[float]
|
|
==== Request
|
|
|
|
`GET /api/logstash/pipeline/<id>`
|
|
|
|
[float]
|
|
==== Path Parameters
|
|
|
|
`id` (required)::
|
|
(string) ID for pipeline.
|
|
|
|
[float]
|
|
==== Examples
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET api/logstash/pipeline/hello-world
|
|
--------------------------------------------------
|
|
// KIBANA
|
|
|
|
A successful call returns a JSON structure similar to the following example:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
{
|
|
"id": "hello-world",
|
|
"description": "Just a simple pipeline",
|
|
"username": "elastic",
|
|
"pipeline": "input { stdin {} } output { stdout {} }",
|
|
"settings": {
|
|
"queue.type": "persistent"
|
|
}
|
|
}
|
|
--------------------------------------------------
|