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

Create Pipeline

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

Create Pipeline

edit

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

The Create Pipeline API enables you to create a centrally-managed Logstash pipeline. You can also use it to update an existing pipeline.

Note: You cannot access this endpoint via the Console in Kibana.

Request

edit

PUT /api/logstash/pipeline/<id>

Path Parameters

edit
id (required)
(string) ID for pipeline. Only alphanumeric characters, hyphens, and underscores may be used.

Request Body

edit
description (optional)
(string) Description for the pipeline
pipeline (required)
(string) Pipeline definition
settings (optional)
(object) Pipeline settings. Supported settings, represented as object keys, are pipeline.workers, pipeline.batch.size, pipeline.batch.delay, queue.type, queue.max_bytes, and queue.checkpoint.writes

Examples

edit
PUT api/logstash/pipeline/hello-world
{
  "pipeline": "input { stdin {} } output { stdout {} }",
  "settings": {
    "queue.type": "persisted"
  }
}
Copy as curl 

A successful call returns an HTTP 204 No Content response.

« Logstash Configuration Management API Retrieve Pipeline »

On this page

Was this helpful?
Feedback