Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • *object Additional properties
      Hide * attributes Show * attributes object
      • descriptionstring Required

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

      • last_modifiedstring | 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:
        DateTimestringUnitMillisnumber

        Time unit for milliseconds

      • pipelinestring Required

        The configuration for the pipeline.

        External documentation
      • pipeline_metadataobject Required
        Hide pipeline_metadata attributes Show pipeline_metadata attributes object
      • pipeline_settingsobject Required
        Hide pipeline_settings attributes Show pipeline_settings attributes object
        • pipeline.workersnumber Required

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

        • pipeline.batch.sizenumber Required

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

        • pipeline.batch.delaynumber Required

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

        • queue.typestring Required

          The internal queuing model to use for event buffering.

        • queue.max_bytes.numbernumber Required

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

        • queue.max_bytes.unitsstring Required

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

        • queue.checkpoint.writesnumber Required

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

      • usernamestring Required

        The user who last updated the pipeline.

GET /_logstash/pipeline
curl \
 --request GET 'http://api.example.com/_logstash/pipeline' \
 --header "Authorization: $API_KEY"
Response examples (200)
A successful response from `GET _logstash/pipeline/my_pipeline`.
{
  "my_pipeline": {
    "description": "Sample pipeline for illustration purposes",
    "last_modified": "2021-01-02T02:50:51.250Z",
    "pipeline_metadata": {
      "type": "logstash_pipeline",
      "version": "1"
    },
    "username": "elastic",
    "pipeline": "input {}\\n filter { grok {} }\\n output {}",
    "pipeline_settings": {
      "pipeline.workers": 1,
      "pipeline.batch.size": 125,
      "pipeline.batch.delay": 50,
      "queue.type": "memory",
      "queue.max_bytes": "1gb",
      "queue.checkpoint.writes": 1024
    }
  }
}