Create or update a Logstash pipeline Added in 7.12.0

PUT /_logstash/pipeline/{id}

Create a pipeline that is used for Logstash Central Management. If the specified pipeline exists, it is replaced.

External documentation

Path parameters

  • id string Required

    An identifier for the pipeline.

application/json

Body Required

  • description string Required

    A description of the pipeline. This description is not used by Elasticsearch or Logstash.

  • last_modified string | number Required

    A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

    One of:
    _types:DateTime string _types:UnitMillis number

    Time unit for milliseconds

  • pipeline string Required

    The configuration for the pipeline.

    External documentation
  • pipeline_metadata object Required

    Additional properties are allowed.

    Hide pipeline_metadata attributes Show pipeline_metadata attributes object
  • pipeline_settings object Required

    Additional properties are allowed.

    Hide pipeline_settings attributes Show pipeline_settings attributes object
    • pipeline.workers number Required

      The number of workers that will, in parallel, execute the filter and output stages of the pipeline.

    • pipeline.batch.size number Required

      The maximum number of events an individual worker thread will collect from inputs before attempting to execute its filters and outputs.

    • pipeline.batch.delay number Required

      When creating pipeline event batches, how long in milliseconds to wait for each event before dispatching an undersized batch to pipeline workers.

    • queue.type string Required

      The internal queuing model to use for event buffering.

    • queue.max_bytes.number number Required

      The total capacity of the queue (queue.type: persisted) in number of bytes.

    • queue.max_bytes.units string Required

      The total capacity of the queue (queue.type: persisted) in terms of units of bytes.

    • queue.checkpoint.writes number Required

      The maximum number of written events before forcing a checkpoint when persistent queues are enabled (queue.type: persisted).

  • username string Required

    The user who last updated the pipeline.

Responses

PUT /_logstash/pipeline/{id} 
curl \
 -X PUT http://api.example.com/_logstash/pipeline/{id} \
 -H "Content-Type: application/json" \
 -d '{"description":"string","":"string","pipeline":"string","pipeline_metadata":{"type":"string","version":"string"},"pipeline_settings":{"pipeline.workers":42.0,"pipeline.batch.size":42.0,"pipeline.batch.delay":42.0,"queue.type":"string","queue.max_bytes.number":42.0,"queue.max_bytes.units":"string","queue.checkpoint.writes":42.0},"username":"string"}'
Request examples 
{
  "description": "string",
  "": "string",
  "pipeline": "string",
  "pipeline_metadata": {
    "type": "string",
    "version": "string"
  },
  "pipeline_settings": {
    "pipeline.workers": 42.0,
    "pipeline.batch.size": 42.0,
    "pipeline.batch.delay": 42.0,
    "queue.type": "string",
    "queue.max_bytes.number": 42.0,
    "queue.max_bytes.units": "string",
    "queue.checkpoint.writes": 42.0
  },
  "username": "string"
}