Create or update Logstash pipeline API

Create or update Logstash pipeline API

This API creates or updates a Logstash pipeline used for Logstash Central Management.

Request

PUT _logstash/pipeline/<pipeline_id>

Prerequisites

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

Description

Creates a Logstash pipeline. If the specified pipeline exists, the pipeline is replaced.

Path parameters

<pipeline_id>

(Required, string) Identifier for the pipeline.

Request body

description

(Optional, string) Description of the pipeline. This description is not used by Elasticsearch or Logstash.

last_modified

(Required, string) Date the pipeline was last updated. Must be in the yyyy-MM-dd'T'HH:mm:ss.SSSZZ strict_date_time format.

pipeline

(Required, string) Configuration for the pipeline. For supported syntax, see the Logstash configuration documentation.

pipeline_metadata

(Required, object) Arbitrary metadata about the pipeline. May have any contents. This metadata is not generated or used by Elasticsearch or Logstash.

pipeline_settings

(Required, object) Settings for the pipeline. Supports only flat keys in dot notation. For supported settings, see the Logstash settings documentation.

username

(Required, string) User who last updated the pipeline.

Examples

The following example creates a new pipeline named my_pipeline:

  1. PUT _logstash/pipeline/my_pipeline
  2. {
  3.   "description": "Sample pipeline for illustration purposes",
  4.   "last_modified": "2021-01-02T02:50:51.250Z",
  5.   "pipeline_metadata": {
  6.     "type": "logstash_pipeline",
  7.     "version": "1"
  8.   },
  9.   "username": "elastic",
  10.   "pipeline": "input {}\n filter { grok {} }\n output {}",
  11.   "pipeline_settings": {
  12.     "pipeline.workers": 1,
  13.     "pipeline.batch.size": 125,
  14.     "pipeline.batch.delay": 50,
  15.     "queue.type": "memory",
  16.     "queue.max_bytes": "1gb",
  17.     "queue.checkpoint.writes": 1024
  18.   }
  19. }

If the request succeeds, you receive an empty response with an appropriate status code.