Create or update a stream Technical Preview

View as Markdown
PUT /api/streams/{name}
Api key auth Basic auth

Spaces method and path for this operation:

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

Refer to Spaces for more information.

Creates or updates a stream definition. Classic streams can not be created through this API, only updated

[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 object

Any of:
object-8 object object-8 object object-4 object
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 '{"stream":{"description":"string","ingest":{"failure_store":{"inherit":{}},"lifecycle":{"dsl":{"data_retention":"string"}},"processing":{"steps":[{"action":"grok","customIdentifier":"string","description":"string","from":"string","ignore_failure":true,"ignore_missing":true,"pattern_definitions":{"additionalProperty1":"string","additionalProperty2":"string"},"patterns":["string"],"where":{"field":"string","range":{}}}]},"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"}}]}}},"dashboards":["string"],"queries":[{"id":"string","title":"string","feature":{"filter":{"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"},"name":"string"},"kql":{"query":"string"},"severity_score":42.0}],"rules":["string"]}'