Create or update a stream
Technical Preview
Creates or updates a stream definition. Classic streams can not be created through this API, only updated
Path parameters
-
name
string Required
Body
object
-
dashboards
array[string] Required Minimum length of each is
1. -
stream
object Required Additional properties are NOT allowed.
PUT
/api/streams/{name}
curl \
--request PUT 'https://localhost:5601/api/streams/{name}' \
--header "Authorization: $API_KEY" \
--header "Content-Type: application/json" \
--header "kbn-xsrf: true" \
--data '{"dashboards":["string"],"stream":{"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"}}]}}}}'
Request examples
Object-2
# Headers
kbn-xsrf: true
# Payload
{
"dashboards": [
"string"
],
"stream": {
"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"
}
}
]
}
}
}
}# Headers
kbn-xsrf: true
# Payload
{
"dashboards": [
"string"
],
"stream": {
"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"
}
}
],
"unwired": {}
}
}
}# Headers
kbn-xsrf: true
# Payload
{
"dashboards": [
"string"
],
"stream": {
"group": {
"description": "string",
"members": [
"string"
]
}
}
}