streams

Fork a stream

Changed on

Spaces method and path for this operation:

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

Refer to Spaces for more information.

Forks a wired stream and creates a child stream<br/><br/>[Required authorization] Route required privileges: manage_stream.

post/api/streams/{name}/_fork

Request

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

Path parameters

namestring required

The name of the parent stream to fork from.

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

draftboolean
status'enabled' | 'disabled'

Response

The stream was forked successfully.

Changes

  • 3e7e7b646f2eRevision changes
    • breaking

      removed subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 from the request property anyOf list

    • warning

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

    • warning

      the / request property's maxLength was set to 200

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 to the request property anyOf list