This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« List Logstash pipeline API Retrieve pipeline API »
Elastic Docs ›Kibana Guide [master] ›REST API ›Logstash configuration management APIs

Create Logstash pipeline API

edit

Create Logstash pipeline API

edit

[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work 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.

Request

edit

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

Path parameters

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

Request body

edit
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 code

edit
204 No Content
Indicates a successful call.

Example

edit
$ curl -X PUT api/logstash/pipeline/hello-world
{
  "pipeline": "input { stdin {} } output { stdout {} }",
  "settings": {
    "queue.type": "persisted"
  }
}
« List Logstash pipeline API Retrieve pipeline API »