4dcb27df2b
* Starting to document Logstash config management APIS * Removing copy pasta * Adding delete pipeline API doc * Mention updates in Create Pipeline API doc * Capitalization fix * Adding Retrieve Pipeline API doc * Adding List Pipelines API doc * Fixing typos * Fixing DELETE pipeline API response code * Add description field to GET pipeline response * Update PUT pipeline API response to match implementation * Fixing and annotating GET pipelines response * Add AIP doc reference to index * Adding xpack role * Adding floats * Missed list item * Fixing rebase auto-merge * Adding intro section to Logstash Configuration Management API page * Bolding "experimental" * Fixing typo
44 lines
No EOL
1.1 KiB
Text
44 lines
No EOL
1.1 KiB
Text
[role="xpack"]
|
|
[[logstash-configuration-management-api-list]]
|
|
=== List Pipelines
|
|
|
|
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
|
|
|
The List Pipelines API enables you to list all centrally-managed Logstash pipelines.
|
|
|
|
[float]
|
|
==== Request
|
|
|
|
`GET /api/logstash/pipelines`
|
|
|
|
[float]
|
|
==== Examples
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET api/logstash/pipelines
|
|
--------------------------------------------------
|
|
// KIBANA
|
|
|
|
A successful call returns a JSON structure similar to the following example:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
{
|
|
"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 may or may not be present, depending on whether Elastic Security was enabled when the pipeline was created or last updated. |