This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« Delete Logstash pipeline API Machine learning APIs »
Elastic Docs ›Elasticsearch Guide [master] ›REST APIs ›Logstash APIs

Get pipeline API

edit

Get pipeline API

edit

This API retrieves pipelines used for Logstash Central Management.

Request

edit

GET _logstash/pipeline

GET _logstash/pipeline/<pipeline_id>

Prerequisites

edit
  • If the Elasticsearch security features are enabled, you must have the manage_logstash_pipelines cluster privilege to use this API.

Description

edit

Retrieve one or more Logstash pipelines.

Path parameters

edit
<pipeline_id>
(Optional, string) Comma-separated list of pipeline identifiers.

Examples

edit

The 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
    }
  }
}
« Delete Logstash pipeline API Machine learning APIs »