|
@@ -1,9 +1,14 @@
|
|
|
[role="xpack"]
|
|
|
[testenv="basic"]
|
|
|
[[logstash-api-put-pipeline]]
|
|
|
-=== Put Pipeline API
|
|
|
+=== Put {ls} pipeline API
|
|
|
+++++
|
|
|
+<titleabbrev>Put {ls} pipeline</titleabbrev>
|
|
|
+++++
|
|
|
|
|
|
-This API creates or updates Pipelines used for Logstash Central Management.
|
|
|
+This API creates or updates a {ls} pipeline used for
|
|
|
+{logstash-ref}/logstash-centralized-pipeline-management.html[{ls} Central
|
|
|
+Management].
|
|
|
|
|
|
[[logstash-api-put-pipeline-request]]
|
|
|
==== {api-request-title}
|
|
@@ -19,25 +24,58 @@ This API creates or updates Pipelines used for Logstash Central Management.
|
|
|
[[logstash-api-put-pipeline-desc]]
|
|
|
==== {api-description-title}
|
|
|
|
|
|
-Creates a Logstash Pipeline. If the specified Pipeline exists, the pipeline is
|
|
|
+Creates a {ls} pipeline. If the specified pipeline exists, the pipeline is
|
|
|
replaced.
|
|
|
|
|
|
[[logstash-api-put-pipeline-params]]
|
|
|
==== {api-path-parms-title}
|
|
|
|
|
|
`<pipeline_id>`::
|
|
|
- (Required, string) Identifier for the Pipeline.
|
|
|
+ (Required, string) Identifier for the pipeline.
|
|
|
+
|
|
|
+[[logstash-api-put-pipeline-request-body]]
|
|
|
+==== {api-request-body-title}
|
|
|
+
|
|
|
+`description`::
|
|
|
+(Optional, string)
|
|
|
+Description of the pipeline. This description is not used by {es} or {ls}.
|
|
|
+
|
|
|
+`last_modified`::
|
|
|
+(Required, string)
|
|
|
+Date the pipeline was last updated. Must be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ`
|
|
|
+<<mapping-date-format,`strict_date_time`>> format.
|
|
|
+
|
|
|
+`pipeline`::
|
|
|
+(Required, string)
|
|
|
+Configuration for the pipeline. For supported syntax, see the
|
|
|
+{logstash-ref}/configuration-file-structure.html[{ls} configuration
|
|
|
+documentation].
|
|
|
+
|
|
|
+`pipeline_metadata`::
|
|
|
+(Required, object)
|
|
|
+Optional metadata about the pipeline. May have any contents. This metadata is
|
|
|
+not generated or used by {es} or {ls}.
|
|
|
+
|
|
|
+`pipeline_settings`::
|
|
|
+(Required, object)
|
|
|
+Settings for the pipeline. Supports only flat keys in dot notation. For
|
|
|
+supported settings, see the {logstash-ref}/logstash-settings-file.html[{ls}
|
|
|
+settings documentation].
|
|
|
+
|
|
|
+`username`::
|
|
|
+(Required, string)
|
|
|
+User who last updated the pipeline.
|
|
|
|
|
|
[[logstash-api-put-pipeline-example]]
|
|
|
==== {api-examples-title}
|
|
|
|
|
|
-The following example creates a new Pipeline named `my_pipeline`:
|
|
|
+The following example creates a new pipeline named `my_pipeline`:
|
|
|
|
|
|
[source,console]
|
|
|
--------------------------------------------------
|
|
|
PUT _logstash/pipeline/my_pipeline
|
|
|
{
|
|
|
- "description": "Sample Pipeline for illustration purposes",
|
|
|
+ "description": "Sample pipeline for illustration purposes",
|
|
|
"last_modified": "2021-01-02T02:50:51.250Z",
|
|
|
"pipeline_metadata": {
|
|
|
"type": "logstash_pipeline",
|