Update ingest stream settings | Kibana API documentation

Update ingest stream settings Technical Preview

PUT /api/streams/{name}/_ingest

Spaces method and path for this operation:

put /s/{space_id}/api/streams/{name}/_ingest

Refer to Spaces for more information.

Upserts the ingest settings of an ingest stream definition

[Required authorization] Route required privileges: manage_stream.

Headers

kbn-xsrf string Required

A required header to protect against CSRF attacks

Path parameters

name string Required

application/json

Body

ingest object Required
Any of:
object-2 object object-2 object
Hide attributes Show attributes

lifecycle object Required

Any of:
object-1 object object-2 object object-3 object

processing object Required

Additional properties are NOT allowed.

Hide processing attribute Show processing attribute object

steps array[object] Required

Any of:
object-1 object object-2 object object-3 object object-4 object object-5 object object-6 object object-7 object object-2 object

Hide attributes Show attributes

action string Required

Value is grok.

customIdentifier string

Minimum length is 1.

description string

from string Required

Minimum length is 1.

ignore_failure boolean

ignore_missing boolean

patterns array[string] Required

At least 1 element. Minimum length of each is 1.

where object

Any of:
object-1 object object-2 object object-2 object object-3 object object-4 object object-5 object object-6 object

Hide attributes Show attributes

contains string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

endsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

eq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

field string Required

Minimum length is 1.

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

neq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

range object

Additional properties are NOT allowed.

Hide range attributes Show range attributes object

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

startsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

Additional properties are NOT allowed.

Hide attributes Show attributes

action string Required

Value is dissect.

append_separator string

Minimum length is 1.

customIdentifier string

Minimum length is 1.

description string

from string Required

Minimum length is 1.

ignore_failure boolean

ignore_missing boolean

pattern string Required

Minimum length is 1.

where object

Any of:
object-1 object object-2 object object-2 object object-3 object object-4 object object-5 object object-6 object

Hide attributes Show attributes

contains string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

endsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

eq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

field string Required

Minimum length is 1.

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

neq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

range object

Additional properties are NOT allowed.

Hide range attributes Show range attributes object

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

startsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

Additional properties are NOT allowed.

Hide attributes Show attributes

action string Required

Value is date.

customIdentifier string

Minimum length is 1.

description string

formats array[string] Required

Minimum length of each is 1.

from string Required

Minimum length is 1.

ignore_failure boolean

output_format string

Minimum length is 1.

to string

Minimum length is 1.

where object

Any of:
object-1 object object-2 object object-2 object object-3 object object-4 object object-5 object object-6 object

Hide attributes Show attributes

contains string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

endsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

eq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

field string Required

Minimum length is 1.

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

neq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

range object

Additional properties are NOT allowed.

Hide range attributes Show range attributes object

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

startsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

Additional properties are NOT allowed.

Hide attributes Show attributes

action string Required

Value is rename.

customIdentifier string

Minimum length is 1.

description string

from string Required

Minimum length is 1.

ignore_failure boolean

ignore_missing boolean

override boolean

to string Required

Minimum length is 1.

where object

Any of:
object-1 object object-2 object object-2 object object-3 object object-4 object object-5 object object-6 object

Hide attributes Show attributes

contains string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

endsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

eq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

field string Required

Minimum length is 1.

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

neq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

range object

Additional properties are NOT allowed.

Hide range attributes Show range attributes object

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

startsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

Additional properties are NOT allowed.

Hide attributes Show attributes

action string Required

Value is set.

copy_from string

Minimum length is 1.

customIdentifier string

Minimum length is 1.

description string

ignore_failure boolean

override boolean

to string Required

Minimum length is 1.

where object

Any of:
object-1 object object-2 object object-2 object object-3 object object-4 object object-5 object object-6 object

Hide attributes Show attributes

contains string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

endsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

eq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

field string Required

Minimum length is 1.

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

neq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

range object

Additional properties are NOT allowed.

Hide range attributes Show range attributes object

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

startsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

Additional properties are NOT allowed.

Hide attributes Show attributes

action string Required

Value is append.

allow_duplicates boolean

customIdentifier string

Minimum length is 1.

description string

ignore_failure boolean

to string Required

Minimum length is 1.

value array Required

At least 1 element.

where object

Any of:
object-1 object object-2 object object-2 object object-3 object object-4 object object-5 object object-6 object

Hide attributes Show attributes

contains string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

endsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

eq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

field string Required

Minimum length is 1.

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

neq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

range object

Additional properties are NOT allowed.

Hide range attributes Show range attributes object

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

startsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

Additional properties are NOT allowed.

Hide attributes Show attributes

action string Required

Value is manual_ingest_pipeline.

customIdentifier string

Minimum length is 1.

description string

ignore_failure boolean

on_failure array[object]

Additional properties are allowed.

processors array[object] Required

Additional properties are NOT allowed.

tag string

where object

Any of:
object-1 object object-2 object object-2 object object-3 object object-4 object object-5 object object-6 object

Hide attributes Show attributes

contains string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

endsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

eq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

field string Required

Minimum length is 1.

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

neq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

range object

Additional properties are NOT allowed.

Hide range attributes Show range attributes object

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

startsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

Additional properties are NOT allowed.

Hide attributes Show attributes

customIdentifier string

where object Required

Any of:
object-1 object object-2 object object-2 object object-3 object object-4 object object-5 object object-6 object

Hide attributes Show attributes

steps array Required

contains string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

endsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

eq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

field string Required

Minimum length is 1.

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

neq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

range object

Additional properties are NOT allowed.

Hide range attributes Show range attributes object

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

startsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

settings object Required

Additional properties are NOT allowed.

Hide settings attributes Show settings attributes object

index.number_of_replicas object

Additional properties are NOT allowed.

Hide index.number_of_replicas attribute Show index.number_of_replicas attribute object

value number Required

index.number_of_shards object

Additional properties are NOT allowed.

Hide index.number_of_shards attribute Show index.number_of_shards attribute object

value number Required

index.refresh_interval object

Additional properties are NOT allowed.

Hide index.refresh_interval attribute Show index.refresh_interval attribute object

value string | number Required

Any of:
string-1 string number-2 number

Value 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.

status string

Values are enabled or disabled.

where object Required

Any of:
object-1 object object-2 object object-2 object object-3 object object-4 object object-5 object object-6 object

Hide attributes Show attributes

contains string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

endsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

eq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

field string Required

Minimum length is 1.

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

neq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

range object

Additional properties are NOT allowed.

Hide range attributes Show range attributes object

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

startsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

Additional properties are NOT allowed.
Hide attributes Show attributes

lifecycle object Required

Any of:
object-1 object object-2 object object-3 object

processing object Required

Additional properties are NOT allowed.

Hide processing attribute Show processing attribute object

steps array[object] Required

Any of:
object-1 object object-2 object object-3 object object-4 object object-5 object object-6 object object-7 object object-2 object

Hide attributes Show attributes

action string Required

Value is grok.

customIdentifier string

Minimum length is 1.

description string

from string Required

Minimum length is 1.

ignore_failure boolean

ignore_missing boolean

patterns array[string] Required

At least 1 element. Minimum length of each is 1.

where object

Any of:
object-1 object object-2 object object-2 object object-3 object object-4 object object-5 object object-6 object

Hide attributes Show attributes

contains string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

endsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

eq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

field string Required

Minimum length is 1.

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

neq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

range object

Additional properties are NOT allowed.

Hide range attributes Show range attributes object

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

startsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

Additional properties are NOT allowed.

Hide attributes Show attributes

action string Required

Value is dissect.

append_separator string

Minimum length is 1.

customIdentifier string

Minimum length is 1.

description string

from string Required

Minimum length is 1.

ignore_failure boolean

ignore_missing boolean

pattern string Required

Minimum length is 1.

where object

Any of:
object-1 object object-2 object object-2 object object-3 object object-4 object object-5 object object-6 object

Hide attributes Show attributes

contains string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

endsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

eq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

field string Required

Minimum length is 1.

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

neq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

range object

Additional properties are NOT allowed.

Hide range attributes Show range attributes object

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

startsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

Additional properties are NOT allowed.

Hide attributes Show attributes

action string Required

Value is date.

customIdentifier string

Minimum length is 1.

description string

formats array[string] Required

Minimum length of each is 1.

from string Required

Minimum length is 1.

ignore_failure boolean

output_format string

Minimum length is 1.

to string

Minimum length is 1.

where object

Any of:
object-1 object object-2 object object-2 object object-3 object object-4 object object-5 object object-6 object

Hide attributes Show attributes

contains string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

endsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

eq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

field string Required

Minimum length is 1.

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

neq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

range object

Additional properties are NOT allowed.

Hide range attributes Show range attributes object

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

startsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

Additional properties are NOT allowed.

Hide attributes Show attributes

action string Required

Value is rename.

customIdentifier string

Minimum length is 1.

description string

from string Required

Minimum length is 1.

ignore_failure boolean

ignore_missing boolean

override boolean

to string Required

Minimum length is 1.

where object

Any of:
object-1 object object-2 object object-2 object object-3 object object-4 object object-5 object object-6 object

Hide attributes Show attributes

contains string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

endsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

eq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

field string Required

Minimum length is 1.

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

neq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

range object

Additional properties are NOT allowed.

Hide range attributes Show range attributes object

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

startsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

Additional properties are NOT allowed.

Hide attributes Show attributes

action string Required

Value is set.

copy_from string

Minimum length is 1.

customIdentifier string

Minimum length is 1.

description string

ignore_failure boolean

override boolean

to string Required

Minimum length is 1.

where object

Any of:
object-1 object object-2 object object-2 object object-3 object object-4 object object-5 object object-6 object

Hide attributes Show attributes

contains string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

endsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

eq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

field string Required

Minimum length is 1.

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

neq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

range object

Additional properties are NOT allowed.

Hide range attributes Show range attributes object

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

startsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

Additional properties are NOT allowed.

Hide attributes Show attributes

action string Required

Value is append.

allow_duplicates boolean

customIdentifier string

Minimum length is 1.

description string

ignore_failure boolean

to string Required

Minimum length is 1.

value array Required

At least 1 element.

where object

Any of:
object-1 object object-2 object object-2 object object-3 object object-4 object object-5 object object-6 object

Hide attributes Show attributes

contains string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

endsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

eq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

field string Required

Minimum length is 1.

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

neq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

range object

Additional properties are NOT allowed.

Hide range attributes Show range attributes object

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

startsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

Additional properties are NOT allowed.

Hide attributes Show attributes

action string Required

Value is manual_ingest_pipeline.

customIdentifier string

Minimum length is 1.

description string

ignore_failure boolean

on_failure array[object]

Additional properties are allowed.

processors array[object] Required

Additional properties are NOT allowed.

tag string

where object

Any of:
object-1 object object-2 object object-2 object object-3 object object-4 object object-5 object object-6 object

Hide attributes Show attributes

contains string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

endsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

eq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

field string Required

Minimum length is 1.

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

neq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

range object

Additional properties are NOT allowed.

Hide range attributes Show range attributes object

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

startsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

Additional properties are NOT allowed.

Hide attributes Show attributes

customIdentifier string

where object Required

Any of:
object-1 object object-2 object object-2 object object-3 object object-4 object object-5 object object-6 object

Hide attributes Show attributes

steps array Required

contains string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

endsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

eq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

field string Required

Minimum length is 1.

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

neq string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

range object

Additional properties are NOT allowed.

Hide range attributes Show range attributes object

gt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

gte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lt string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

lte string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

startsWith string | number | boolean

Any of:
string-1 string number-2 number boolean-3 boolean

settings object Required

Additional properties are NOT allowed.

Hide settings attributes Show settings attributes object

index.number_of_replicas object

Additional properties are NOT allowed.

Hide index.number_of_replicas attribute Show index.number_of_replicas attribute object

value number Required

index.number_of_shards object

Additional properties are NOT allowed.

Hide index.number_of_shards attribute Show index.number_of_shards attribute object

value number Required

index.refresh_interval object

Additional properties are NOT allowed.

Hide index.refresh_interval attribute Show index.refresh_interval attribute object

value string | number Required

Any of:
string-1 string number-2 number

Value is -1.

classic object Required

Additional properties are NOT allowed.

Hide classic attribute Show classic attribute object

field_overrides object

PUT /api/streams/{name}/_ingest

curl \ --request PUT 'https://localhost:5601/api/streams/{name}/_ingest' \ --header "Authorization: $API_KEY" \ --header "Content-Type: application/json" \ --header "kbn-xsrf: true" \ --data '{"ingest":{"lifecycle":{"dsl":{"data_retention":"string"}},"processing":{"steps":[{"action":"grok","customIdentifier":"string","description":"string","from":"string","ignore_failure":true,"ignore_missing":true,"patterns":["string"],"where":{"contains":"string","endsWith":"string","eq":"string","field":"string","gt":"string","gte":"string","lt":"string","lte":"string","neq":"string","range":{"gt":"string","gte":"string","lt":"string","lte":"string"},"startsWith":"string"}}]},"settings":{"index.number_of_replicas":{"value":42.0},"index.number_of_shards":{"value":42.0},"index.refresh_interval":{"value":"string"}},"wired":{"fields":{},"routing":[{"destination":"string","status":"enabled","where":{"contains":"string","endsWith":"string","eq":"string","field":"string","gt":"string","gte":"string","lt":"string","lte":"string","neq":"string","range":{"gt":"string","gte":"string","lt":"string","lte":"string"},"startsWith":"string"}}]}}}'

Update ingest stream settings Technical Preview

Headers

Path parameters

Body

ingest object Required

value string | number Required

where object Required