61 lines
1.5 KiB
Text
61 lines
1.5 KiB
Text
[[logstash-configuration-management-api-create]]
|
|
=== Create Logstash pipeline API
|
|
++++
|
|
<titleabbrev>Create Logstash pipeline</titleabbrev>
|
|
++++
|
|
|
|
experimental[] Create a centrally-managed Logstash pipeline, or update an existing pipeline.
|
|
|
|
[[logstash-configuration-management-api-create-request]]
|
|
==== Request
|
|
|
|
`PUT <kibana host>:<port>/api/logstash/pipeline/<id>`
|
|
|
|
[[logstash-configuration-management-api-create-params]]
|
|
==== Path parameters
|
|
|
|
`id`::
|
|
(Required, string) The pipeline ID. Only alphanumeric characters, hyphens, and underscores are supported.
|
|
|
|
[[logstash-configuration-management-api-create-request-body]]
|
|
==== Request body
|
|
|
|
`description`::
|
|
(Optional, string) The pipeline description.
|
|
|
|
`pipeline`::
|
|
(Required, string) The pipeline definition.
|
|
|
|
`settings`::
|
|
(Optional, object) The pipeline settings. 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`
|
|
|
|
[[logstash-configuration-management-api-create-codes]]
|
|
==== Response code
|
|
|
|
`204 No Content`::
|
|
Indicates a successful call.
|
|
|
|
[float]
|
|
[[logstash-configuration-management-api-create-example]]
|
|
==== Example
|
|
|
|
[source,sh]
|
|
--------------------------------------------------
|
|
$ curl -X PUT api/logstash/pipeline/hello-world
|
|
{
|
|
"pipeline": "input { stdin {} } output { stdout {} }",
|
|
"settings": {
|
|
"queue.type": "persisted"
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// KIBANA
|