Logstash configuration management APIs - Create Logstash pipeline - 《Kibana v7.9 Guide》

Create Logstash pipeline API

Create Logstash pipeline API

[experimental] This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. Create a centrally-managed Logstash pipeline, or update an existing pipeline.

Request

PUT <kibana host>:<port>/api/logstash/pipeline/<id>

Path parameters

id

(Required, string) The pipeline ID. Only alphanumeric characters, hyphens, and underscores are supported.

Request body

description

(Optional, string) The pipeline description.

pipeline

(Required, string) The pipeline definition.

settings

(Optional, object) The 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.

Response code

204 No Content

Indicates a successful call.

Example

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