Create Logstash pipeline APIedit

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

Requestedit

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

Path parametersedit

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

Request bodyedit

description
(Optional, string) The pipeline description.
pipeline
(Required, string) The pipeline definition.
settings

(Optional, object) The pipeline settings. Supported settings, represented as object keys, include the following:

  • pipeline.workers
  • pipeline.batch.size
  • pipeline.batch.delay
  • pipeline.ecs_compatibility
  • pipeline.ordered
  • queue.type
  • queue.max_bytes
  • queue.checkpoint.writes

Response codeedit

204 No Content
Indicates a successful call.

Exampleedit

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