Get Logstash pipelines

GET /_logstash/pipeline/{id}
GET /_logstash/pipeline

Get pipelines that are used for Logstash Central Management.

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Response

application/json

Examples

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET _logstash/pipeline/my_pipeline

JavaScript Elasticsearch JavaScript Client

const response = await client.logstash.getPipeline({
  id: "my_pipeline",
});

Python Elasticsearch Python Client

resp = client.logstash.get_pipeline(
    id="my_pipeline",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_logstash/pipeline/my_pipeline" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.logstash().getPipeline(g -> g
    .id("my_pipeline")
);

PHP Elasticsearch PHP Client

$resp = $client->logstash()->getPipeline([
    "id" => "my_pipeline",
]);

Ruby Elasticsearch Ruby Client

response = client.logstash.get_pipeline(
  id: "my_pipeline"
)

Response

A successful response from GET _logstash/pipeline/my_pipeline.

{
  "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
    }
  }
}