New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Delete Logstash pipeline API Machine learning anomaly detection APIs »
Elastic Docs ›Elasticsearch Guide [7.15] ›REST APIs ›Logstash APIs

Get pipeline API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

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:

GET _logstash/pipeline/my_pipeline
Copy as curlTry in Elastic 

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.number": 1,
      "queue.max_bytes.units": "gb",
      "queue.checkpoint.writes": 1024
    }
  }
}
« Delete Logstash pipeline API Machine learning anomaly detection APIs »

On this page

Was this helpful?
Feedback