Upsert query stream settings

Base URL: https://{kibana_url}

PUT /api/streams/{name}/_query
PUT /s/{space_id}/api/streams/{name}/_query

Auth

Upserts the query settings of a query stream definition

Required privileges

Privileges manage_stream

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
name string · max length: 200 required: The name of the query stream.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

field_descriptions map string to string
query object required

Response

200

The query stream settings were updated successfully.

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT kbn:/api/streams/NAME/_query
{
  "query": {
    "esql": "FROM logs* | WHERE log.level == \u0022error\u0022 | KEEP @timestamp, message, host.name, log.level"
  }
}

Generated from the API spec

curl Shell

curl -X PUT "${KIBANA_URL}/api/streams/${NAME}/_query" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "query": {
      "esql": "FROM logs* | WHERE log.level == \u0022error\u0022 | KEEP @timestamp, message, host.name, log.level"
    }
  }'

Generated from the API spec

Response

No body

Required privileges

Path parameters

Header parameters

Request body { }

Response

Request body