Fork a stream

Base URL: https://{kibana_url}

POST /api/streams/{name}/_fork
POST /s/{space_id}/api/streams/{name}/_fork

Auth

Forks a wired stream and creates a child stream

Required authorization

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 parent stream to fork from.

Header parameters

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

Request body

draft boolean
status enum: Values: enabled disabled
stream object required
where union anyOf required: Any of:

Response

200

The stream was forked successfully.

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/streams/NAME/_fork
{
  "status": "enabled",
  "stream": {
    "name": "logs.nginx.errors"
  },
  "where": {
    "eq": "500",
    "field": "http.response.status_code"
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/streams/${NAME}/_fork" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "enabled",
    "stream": {
      "name": "logs.nginx.errors"
    },
    "where": {
      "eq": "500",
      "field": "http.response.status_code"
    }
  }'

Generated from the API spec

Response

No body