logstash

Create or update a Logstash pipeline

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.

put/api/logstash/pipeline/{id}

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/logstash/pipeline/{id}
  • Auth
    • API key in header Authorization
    • or HTTP basic

Path parameters

idstring required

An identifier for the pipeline. Pipeline ID must begin with a letter or underscore and can contain only letters, underscores, dashes, hyphens, and numbers.

Request body

descriptionstring

A description of the pipeline.

pipelinestring required

A definition for the pipeline.

settingsobject

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

Indicates a successful call

Changes

No operation changes recorded.