Get pipeline API
editGet pipeline API
editThis API retrieves pipelines used for Logstash Central Management.
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
manage_logstash_pipelinescluster privilege to use this API.
Description
editRetrieve one or more Logstash pipelines.
Path parameters
edit-
<pipeline_id> - (Optional, string) Comma-separated list of pipeline identifiers.
Examples
editThe following example retrieves the pipeline named my_pipeline:
resp = client.logstash.get_pipeline(
id="my_pipeline",
)
print(resp)
response = client.logstash.get_pipeline( id: 'my_pipeline' ) puts response
const response = await client.logstash.getPipeline({
id: "my_pipeline",
});
console.log(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
}
}
}