Export stream content

Base URL: https://{kibana_url}

POST /api/streams/{name}/content/export
POST /s/{space_id}/api/streams/{name}/content/export

Auth

Exports a content pack with the stream structure (routing, mappings, and processing). Significant-event queries are not included.

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 stream to export content from.

Header parameters

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

Request body

description string · max length: 1000 required
include union anyOf required: Any of:
name string · max length: 256 required
version string · max length: 100 required

Response

200

Content pack archive for the stream.

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/streams/NAME/content/export
{
  "description": "Nginx stream content pack",
  "include": {
    "objects": {
      "all": {}
    }
  },
  "name": "nginx-pack",
  "version": "1.0.0"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/streams/${NAME}/content/export" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Nginx stream content pack",
    "include": {
      "objects": {
        "all": {}
      }
    },
    "name": "nginx-pack",
    "version": "1.0.0"
  }'

Generated from the API spec

Response

No body