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.
« Create Pipeline Delete Pipeline »
Elastic Docs ›Kibana User Guide [6.4] ›REST API ›Logstash Configuration Management API

Retrieve Pipeline

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

Retrieve Pipeline

edit

This functionality is experimental and may be changed or removed completely in a future release.

The Retrieve Pipeline API enables you to retrieve a centrally-managed Logstash pipeline.

Request

edit

GET /api/logstash/pipeline/<id>

Path Parameters

edit
id (required)
(string) ID for pipeline.

Examples

edit
GET api/logstash/pipeline/hello-world
Copy as curl 

A successful call returns a JSON structure similar to the following example:

{
  "id": "hello-world",
  "description": "Just a simple pipeline",
  "username": "elastic",
  "pipeline": "input { stdin {} } output { stdout {} }",
  "settings": {
    "queue.type": "persistent"
  }
}
« Create Pipeline Delete Pipeline »

On this page

Was this helpful?
Feedback