Create or update a Logstash pipeline Technical Preview

PUT /api/logstash/pipeline/{id}
Api key auth Basic auth

Create a centrally-managed Logstash pipeline or update a pipeline. To use this API, you must have either the logstash_admin built-in role or a customized Logstash writer role.

Secure your connection

Path parameters

  • id string Required

    An identifier for the pipeline. Only alphanumeric characters, hyphens, and underscores are supported.

application/json

Body

  • description string

    A description of the pipeline.

  • pipeline string Required

    A definition for the pipeline.

  • settings object

    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

Responses

  • 204

    Indicates a successful call

PUT /api/logstash/pipeline/{id} 
curl \
 --request PUT 'http://localhost:5601/api/logstash/pipeline/{id}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"pipeline\": \"input { stdin {} } output { stdout {} }\",\n  \"settings\": {\n    \"queue.type\": \"persisted\"\n  }\n}"'
Request example 
{
  "pipeline": "input { stdin {} } output { stdout {} }",
  "settings": {
    "queue.type": "persisted"
  }
}