Sign in

v1

latestOpenAPI 3.0.02026-07-142351,1971.3 MB
Logs Pipelines

Get a pipeline

Get a specific pipeline from your organization. This endpoint takes no JSON arguments.

get/api/v1/logs/config/pipelines/{pipeline_id}

Path parameters

pipeline_idstring required

ID of the pipeline to get.

Response

OK

descriptionstring

A description of the pipeline.

idstring

ID of the pipeline.

is_enabledboolean

Whether or not the pipeline is enabled.

is_read_onlyboolean

Whether or not the pipeline can be edited.

namestring required

Name of the pipeline.

tagsstring[]

A list of tags associated with the pipeline.

typestring

Type of pipeline.

Example response

{
  "filter": {
    "query": "source:python"
  },
  "processors": [
    {
      "grok": {
        "match_rules": "rule_name_1 foo\nrule_name_2 bar",
        "support_rules": "rule_name_1 foo\nrule_name_2 bar"
      },
      "source": "message",
      "type": "grok-parser"
    }
  ],
  "type": "pipeline"
}