IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Get pipeline APIedit
This API retrieves pipelines used for Logstash Central Management.
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have the
manage_logstash_pipelines
cluster privilege to use this API.
Descriptionedit
Retrieve one or more Logstash pipelines.
Path parametersedit
-
<pipeline_id>
- (Optional, string) Comma-separated list of pipeline identifiers.
Examplesedit
The following example retrieves the pipeline named my_pipeline
:
response = client.logstash.get_pipeline( id: 'my_pipeline' ) puts response
GET _logstash/pipeline/my_pipeline
If the request succeeds, the body of the response contains the pipeline definition:
{ "my_pipeline": { "description": "Sample pipeline for illustration purposes", "last_modified": "2021-01-02T02:50:51.250Z", "pipeline_metadata": { "type": "logstash_pipeline", "version": "1" }, "username": "elastic", "pipeline": "input {}\n filter { grok {} }\n output {}", "pipeline_settings": { "pipeline.workers": 1, "pipeline.batch.size": 125, "pipeline.batch.delay": 50, "queue.type": "memory", "queue.max_bytes": "1gb", "queue.checkpoint.writes": 1024 } } }