streams

Create or update a stream

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}</span></div>

Refer to Spaces for more information.

Creates or updates a stream definition. Classic streams can not be created through this API, only updated<br/><br/>[Required authorization] Route required privileges: manage_stream.

put/api/streams/{name}

Request

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

Path parameters

namestring required

The name of the stream.

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

OR
OR

Response

The stream was created or updated successfully.

Changes

  • 3e7e7b646f2eRevision changes
    • breaking

      removed subschema #1 subschema #2 subschema #3 from the ///////////// request property anyOf list

    • breaking

      removed subschema #1 subschema #2 subschema #3 from the ///////////// request property anyOf list

    • warning

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

    • info

      added subschema #1 subschema #2 subschema #3 to the ///////////// request property anyOf list

    • info

      added subschema #1 subschema #2 subschema #3 to the ///////////// request property anyOf list

  • 0ccc4e4f608aRevision changes
    • breaking

      the ////// request property type changed from object to no type

    • warning

      removed the request property ///////

    • warning

      removed the request property ///////

    • warning

      removed the request property ///////

    • info

      added subschema #1 subschema #2 to the ////// request property anyOf list