Enable a named stream

POST /_streams/{name}/_enable

Turn on the named stream feature for this cluster.

NOTE: To protect existing data, this feature can be turned on only if the cluster does not have existing indices or data streams that match the pattern <name>|<name>.* for the enabled stream type name. If those indices or data streams exist, a 409 - Conflict response and error is returned.

Required authorization

Cluster privileges: manage

Path Parameters

name enum StreamType required

The stream type to enable.

Supported values include:

logs: The logs stream type.
logs.otel: The logs.otel stream type, meant for OTel-formatted data.
logs.ecs: The logs.ecs stream type, meant for ECS-formatted data.

Values: logs logs.otel logs.ecs

Query Parameters

Response

application/json

Examples

A successful response from POST _streams/logs.otel/_enable endpoint

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST _streams/logs.otel/_enable

JavaScript Elasticsearch JavaScript Client

const response = await client.streams.logsEnable({
  name: "logs.otel",
});

Python Elasticsearch Python Client

resp = client.streams.logs_enable(
    name="logs.otel",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_streams/logs.otel/_enable" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.streams().logsEnable(l -> l);

C# Elasticsearch .NET Client

var response = await client.Streams.LogsEnableAsync(name: StreamType.LogsOtel);

PHP Elasticsearch PHP Client

$resp = $client->streams()->logsEnable([
    "name" => "logs.otel",
]);

Ruby Elasticsearch Ruby Client

response = client.streams.logs_enable(
  name: "logs.otel"
)

Response

{
  "acknowledged": true
}

Required authorization

Path Parameters

Query Parameters { master_timeout , timeout , }

Response

Query Parameters