Upsert group stream settings Technical Preview

PUT /api/streams/{name}/_group
Api key auth

Upserts the group settings of a group stream definition

Headers

  • kbn-xsrf string Required

    A required header to protect against CSRF attacks

application/json

Body

  • group object Required

    Additional properties are NOT allowed.

    Hide group attributes Show group attributes object
PUT /api/streams/{name}/_group 
curl \
 --request PUT 'http://localhost:5622/api/streams/{name}/_group' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: true" \
 --data '{"group":{"description":"string","members":["string"]}}'
Request examples 
# Headers
kbn-xsrf: true

# Payload
{
  "group": {
    "description": "string",
    "members": [
      "string"
    ]
  }
}