Create or update a stream
Technical Preview
Creates or updates a stream definition. Classic streams can not be created through this API, only updated
[Required authorization] Route required privileges: manage_stream.
Path parameters
-
name
string Required
Body
object
-
stream
object Required Additional properties are allowed.
Hide stream attributes Show stream attributes object
-
name
Required -
description
string Required -
ingest
object Required Additional properties are NOT allowed.
Hide ingest attributes Show ingest attributes object
lifecycle
object Required Any of: Hide attribute Show attribute
-
dsl
object Required Additional properties are NOT allowed.
Hide dsl attribute Show dsl attribute object
-
data_retention
string Minimum length is
1
.
-
Hide attribute Show attribute
-
inherit
object Required Additional properties are NOT allowed.
-
lifecycle
object Required Any of: Hide attribute Show attribute
-
dsl
object Required Additional properties are NOT allowed.
Hide dsl attribute Show dsl attribute object
-
data_retention
string Minimum length is
1
.
-
Hide attribute Show attribute
-
inherit
object Required Additional properties are NOT allowed.
-
-
processing
array[object] Required Any of: Hide attribute Show attribute
-
date
object Required Hide date attributes Show date attributes object
-
description
string if
object Any of: Hide attributes Show attributes
Hide attribute Show attribute
-
and
array Required
Hide attribute Show attribute
-
or
array Required
Hide attribute Show attribute
-
never
object Required Additional properties are NOT allowed.
Hide attribute Show attribute
-
always
object Required Additional properties are NOT allowed.
-
-
ignore_failure
boolean -
field
string Required Minimum length is
1
. -
formats
array[string] Required Minimum length of each is
1
. -
locale
string Minimum length is
1
. -
output_format
string Minimum length is
1
. -
target_field
string Minimum length is
1
. -
timezone
string Minimum length is
1
.
-
Hide attribute Show attribute
-
dissect
object Required Hide dissect attributes Show dissect attributes object
-
description
string if
object Any of: Hide attributes Show attributes
Hide attribute Show attribute
-
and
array Required
Hide attribute Show attribute
-
or
array Required
Hide attribute Show attribute
-
never
object Required Additional properties are NOT allowed.
Hide attribute Show attribute
-
always
object Required Additional properties are NOT allowed.
-
-
ignore_failure
boolean -
append_separator
string Minimum length is
1
. -
field
string Required Minimum length is
1
. -
ignore_missing
boolean -
pattern
string Required Minimum length is
1
.
-
Hide attribute Show attribute
-
grok
object Required Hide grok attributes Show grok attributes object
-
description
string if
object Any of: Hide attributes Show attributes
Hide attribute Show attribute
-
and
array Required
Hide attribute Show attribute
-
or
array Required
Hide attribute Show attribute
-
never
object Required Additional properties are NOT allowed.
Hide attribute Show attribute
-
always
object Required Additional properties are NOT allowed.
-
-
ignore_failure
boolean -
field
string Required Minimum length is
1
. -
ignore_missing
boolean -
pattern_definitions
object Hide pattern_definitions attribute Show pattern_definitions attribute object
-
*
string Additional properties
-
-
patterns
array[string] Required At least
1
element. Minimum length of each is1
.
-
Hide attribute Show attribute
-
manual_ingest_pipeline
object Required Hide manual_ingest_pipeline attributes Show manual_ingest_pipeline attributes object
-
description
string if
object Any of: Hide attributes Show attributes
Hide attribute Show attribute
-
and
array Required
Hide attribute Show attribute
-
or
array Required
Hide attribute Show attribute
-
never
object Required Additional properties are NOT allowed.
Hide attribute Show attribute
-
always
object Required Additional properties are NOT allowed.
-
-
ignore_failure
boolean -
on_failure
array[object] Additional properties are allowed.
-
processors
array[object] Required Additional properties are NOT allowed.
-
tag
string
-
Hide attribute Show attribute
-
kv
object Required Hide kv attributes Show kv attributes object
-
description
string if
object Any of: Hide attributes Show attributes
Hide attribute Show attribute
-
and
array Required
Hide attribute Show attribute
-
or
array Required
Hide attribute Show attribute
-
never
object Required Additional properties are NOT allowed.
Hide attribute Show attribute
-
always
object Required Additional properties are NOT allowed.
-
-
ignore_failure
boolean -
exclude_keys
array[string] Minimum length of each is
1
. -
field
string Required Minimum length is
1
. -
field_split
string Required -
ignore_missing
boolean -
include_keys
array[string] Minimum length of each is
1
. -
prefix
string Minimum length is
1
. -
strip_brackets
boolean -
target_field
string Minimum length is
1
. -
trim_key
string Minimum length is
1
. -
trim_value
string Minimum length is
1
. -
value_split
string Required
-
Hide attribute Show attribute
-
geoip
object Required Additional properties are NOT allowed.
Hide geoip attributes Show geoip attributes object
-
database_file
string Minimum length is
1
. -
field
string Required Minimum length is
1
. -
first_only
boolean -
ignore_missing
boolean -
properties
array[string] Minimum length of each is
1
. -
target_field
string Minimum length is
1
.
-
Hide attribute Show attribute
-
rename
object Required Hide rename attributes Show rename attributes object
-
description
string if
object Any of: Hide attributes Show attributes
Hide attribute Show attribute
-
and
array Required
Hide attribute Show attribute
-
or
array Required
Hide attribute Show attribute
-
never
object Required Additional properties are NOT allowed.
Hide attribute Show attribute
-
always
object Required Additional properties are NOT allowed.
-
-
ignore_failure
boolean -
field
string Required Minimum length is
1
. -
ignore_missing
boolean -
override
boolean -
target_field
string Required Minimum length is
1
.
-
Hide attribute Show attribute
-
set
object Required Hide set attributes Show set attributes object
-
description
string if
object Any of: Hide attributes Show attributes
Hide attribute Show attribute
-
and
array Required
Hide attribute Show attribute
-
or
array Required
Hide attribute Show attribute
-
never
object Required Additional properties are NOT allowed.
Hide attribute Show attribute
-
always
object Required Additional properties are NOT allowed.
-
-
ignore_failure
boolean -
field
string Required Minimum length is
1
. -
ignore_empty_value
boolean -
media_type
string -
override
boolean -
value
string Required Minimum length is
1
.
-
Hide attribute Show attribute
-
urldecode
object Required Hide urldecode attributes Show urldecode attributes object
-
description
string if
object Any of: Hide attributes Show attributes
Hide attribute Show attribute
-
and
array Required
Hide attribute Show attribute
-
or
array Required
Hide attribute Show attribute
-
never
object Required Additional properties are NOT allowed.
Hide attribute Show attribute
-
always
object Required Additional properties are NOT allowed.
-
-
ignore_failure
boolean -
field
string Required Minimum length is
1
. -
ignore_missing
boolean -
target_field
string Minimum length is
1
.
-
Hide attribute Show attribute
-
user_agent
object Required Additional properties are NOT allowed.
Hide user_agent attributes Show user_agent attributes object
-
field
string Required Minimum length is
1
. -
ignore_missing
boolean -
properties
array[string] Minimum length of each is
1
. -
regex_file
string Minimum length is
1
. -
target_field
string Minimum length is
1
.
-
-
-
wired
object Required Additional properties are NOT allowed.
Hide wired attributes Show wired attributes object
-
fields
object Required -
routing
array[object] Required Hide routing attributes Show routing attributes object
-
destination
string Required Minimum length is
1
. if
object Required Any of: Hide attributes Show attributes
Hide attribute Show attribute
-
and
array Required
Hide attribute Show attribute
-
or
array Required
Hide attribute Show attribute
-
never
object Required Additional properties are NOT allowed.
Hide attribute Show attribute
-
always
object Required Additional properties are NOT allowed.
-
-
-
-
-
dashboards
array[string] Required -
queries
array[object] Required
-
stream
object Required Additional properties are allowed.
Hide stream attributes Show stream attributes object
-
name
Required -
description
string Required -
ingest
object Required Additional properties are NOT allowed.
Hide ingest attributes Show ingest attributes object
lifecycle
object Required Any of: Hide attribute Show attribute
-
dsl
object Required Additional properties are NOT allowed.
Hide dsl attribute Show dsl attribute object
-
data_retention
string Minimum length is
1
.
-
Hide attribute Show attribute
-
inherit
object Required Additional properties are NOT allowed.
-
lifecycle
object Required Any of: Hide attribute Show attribute
-
dsl
object Required Additional properties are NOT allowed.
Hide dsl attribute Show dsl attribute object
-
data_retention
string Minimum length is
1
.
-
Hide attribute Show attribute
-
inherit
object Required Additional properties are NOT allowed.
-
-
processing
array[object] Required Any of: Hide attribute Show attribute
-
date
object Required Hide date attributes Show date attributes object
-
description
string if
object Any of: Hide attributes Show attributes
Hide attribute Show attribute
-
and
array Required
Hide attribute Show attribute
-
or
array Required
Hide attribute Show attribute
-
never
object Required Additional properties are NOT allowed.
Hide attribute Show attribute
-
always
object Required Additional properties are NOT allowed.
-
-
ignore_failure
boolean -
field
string Required Minimum length is
1
. -
formats
array[string] Required Minimum length of each is
1
. -
locale
string Minimum length is
1
. -
output_format
string Minimum length is
1
. -
target_field
string Minimum length is
1
. -
timezone
string Minimum length is
1
.
-
Hide attribute Show attribute
-
dissect
object Required Hide dissect attributes Show dissect attributes object
-
description
string if
object Any of: Hide attributes Show attributes
Hide attribute Show attribute
-
and
array Required
Hide attribute Show attribute
-
or
array Required
Hide attribute Show attribute
-
never
object Required Additional properties are NOT allowed.
Hide attribute Show attribute
-
always
object Required Additional properties are NOT allowed.
-
-
ignore_failure
boolean -
append_separator
string Minimum length is
1
. -
field
string Required Minimum length is
1
. -
ignore_missing
boolean -
pattern
string Required Minimum length is
1
.
-
Hide attribute Show attribute
-
grok
object Required Hide grok attributes Show grok attributes object
-
description
string if
object Any of: Hide attributes Show attributes
Hide attribute Show attribute
-
and
array Required
Hide attribute Show attribute
-
or
array Required
Hide attribute Show attribute
-
never
object Required Additional properties are NOT allowed.
Hide attribute Show attribute
-
always
object Required Additional properties are NOT allowed.
-
-
ignore_failure
boolean -
field
string Required Minimum length is
1
. -
ignore_missing
boolean -
pattern_definitions
object Hide pattern_definitions attribute Show pattern_definitions attribute object
-
*
string Additional properties
-
-
patterns
array[string] Required At least
1
element. Minimum length of each is1
.
-
Hide attribute Show attribute
-
manual_ingest_pipeline
object Required Hide manual_ingest_pipeline attributes Show manual_ingest_pipeline attributes object
-
description
string if
object Any of: Hide attributes Show attributes
Hide attribute Show attribute
-
and
array Required
Hide attribute Show attribute
-
or
array Required
Hide attribute Show attribute
-
never
object Required Additional properties are NOT allowed.
Hide attribute Show attribute
-
always
object Required Additional properties are NOT allowed.
-
-
ignore_failure
boolean -
on_failure
array[object] Additional properties are allowed.
-
processors
array[object] Required Additional properties are NOT allowed.
-
tag
string
-
Hide attribute Show attribute
-
kv
object Required Hide kv attributes Show kv attributes object
-
description
string if
object Any of: Hide attributes Show attributes
Hide attribute Show attribute
-
and
array Required
Hide attribute Show attribute
-
or
array Required
Hide attribute Show attribute
-
never
object Required Additional properties are NOT allowed.
Hide attribute Show attribute
-
always
object Required Additional properties are NOT allowed.
-
-
ignore_failure
boolean -
exclude_keys
array[string] Minimum length of each is
1
. -
field
string Required Minimum length is
1
. -
field_split
string Required -
ignore_missing
boolean -
include_keys
array[string] Minimum length of each is
1
. -
prefix
string Minimum length is
1
. -
strip_brackets
boolean -
target_field
string Minimum length is
1
. -
trim_key
string Minimum length is
1
. -
trim_value
string Minimum length is
1
. -
value_split
string Required
-
Hide attribute Show attribute
-
geoip
object Required Additional properties are NOT allowed.
Hide geoip attributes Show geoip attributes object
-
database_file
string Minimum length is
1
. -
field
string Required Minimum length is
1
. -
first_only
boolean -
ignore_missing
boolean -
properties
array[string] Minimum length of each is
1
. -
target_field
string Minimum length is
1
.
-
Hide attribute Show attribute
-
rename
object Required Hide rename attributes Show rename attributes object
-
description
string if
object Any of: Hide attributes Show attributes
Hide attribute Show attribute
-
and
array Required
Hide attribute Show attribute
-
or
array Required
Hide attribute Show attribute
-
never
object Required Additional properties are NOT allowed.
Hide attribute Show attribute
-
always
object Required Additional properties are NOT allowed.
-
-
ignore_failure
boolean -
field
string Required Minimum length is
1
. -
ignore_missing
boolean -
override
boolean -
target_field
string Required Minimum length is
1
.
-
Hide attribute Show attribute
-
set
object Required Hide set attributes Show set attributes object
-
description
string if
object Any of: Hide attributes Show attributes
Hide attribute Show attribute
-
and
array Required
Hide attribute Show attribute
-
or
array Required
Hide attribute Show attribute
-
never
object Required Additional properties are NOT allowed.
Hide attribute Show attribute
-
always
object Required Additional properties are NOT allowed.
-
-
ignore_failure
boolean -
field
string Required Minimum length is
1
. -
ignore_empty_value
boolean -
media_type
string -
override
boolean -
value
string Required Minimum length is
1
.
-
Hide attribute Show attribute
-
urldecode
object Required Hide urldecode attributes Show urldecode attributes object
-
description
string if
object Any of: Hide attributes Show attributes
Hide attribute Show attribute
-
and
array Required
Hide attribute Show attribute
-
or
array Required
Hide attribute Show attribute
-
never
object Required Additional properties are NOT allowed.
Hide attribute Show attribute
-
always
object Required Additional properties are NOT allowed.
-
-
ignore_failure
boolean -
field
string Required Minimum length is
1
. -
ignore_missing
boolean -
target_field
string Minimum length is
1
.
-
Hide attribute Show attribute
-
user_agent
object Required Additional properties are NOT allowed.
Hide user_agent attributes Show user_agent attributes object
-
field
string Required Minimum length is
1
. -
ignore_missing
boolean -
properties
array[string] Minimum length of each is
1
. -
regex_file
string Minimum length is
1
. -
target_field
string Minimum length is
1
.
-
-
-
unwired
object Required Additional properties are NOT allowed.
-
-
dashboards
array[string] Required -
queries
array[object] Required
-
stream
object Required Additional properties are allowed.
Hide stream attributes Show stream attributes object
-
name
Required -
description
string Required -
group
object Required Additional properties are NOT allowed.
Hide group attribute Show group attribute object
-
members
array[string] Required
-
-
-
dashboards
array[string] Required -
queries
array[object] Required
curl \
--request PUT 'https://localhost:5601/api/streams/{name}' \
--header "Authorization: $API_KEY" \
--header "Content-Type: application/json" \
--header "kbn-xsrf: true" \
--data '{"stream":{"description":"string","ingest":{"lifecycle":{"dsl":{"data_retention":"string"}},"processing":[{"date":{"description":"string","if":{"field":"string","operator":"exists"},"ignore_failure":true,"field":"string","formats":["string"],"locale":"string","output_format":"string","target_field":"string","timezone":"string"}}],"wired":{"fields":{},"routing":[{"destination":"string","if":{"field":"string","operator":"exists"}}]}}},"dashboards":["string"],"queries":[{"id":"string","title":"string","kql":{"query":"string"}}]}'