streams

Upsert query stream settings

Changed on

Spaces method and path for this operation:

<div><span class="operation-verb put">put</span>&nbsp;<span class="operation-path">/s/{space_id}/api/streams/{name}/_query</span></div>

Refer to Spaces for more information.

Upserts the query settings of a query stream definition<br/><br/>[Required authorization] Route required privileges: manage_stream.

put/api/streams/{name}/_query

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/streams/{name}/_query
  • Auth
    • API key in header Authorization
    • or HTTP basic

Path parameters

namestring required

The name of the query stream.

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

field_descriptionsobject

Response

The query stream settings were updated successfully.

Changes

  • 3e7e7b646f2eRevision changes
    • warning

      for the path request parameter name, the maxLength was set to 200

    • warning

      the / request property's maxLength was set to 1000

    • warning

      the / request property's maxLength was set to 65535