Enable a named stream

  • POST /_streams/{name}/_enable
Auth

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 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

master_timeout string · default: 30s

The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

timeout string · default: 30s

The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Responses

application/json
acknowledged boolean required

For a successful response, this value is always true. On failure, an exception is returned instead.

An index named logs.otel, or starting with logs.otel., already exists.

application/json
error object required
type string required

The type of error

reason union string nullable

A human-readable explanation of the error, in English.

One of: string
stack_trace string

The server stack trace. Present only if the error_trace=true parameter was sent with the request.

caused_by object
Same fields as error
root_cause object[]
Same fields as error
suppressed object[]
Same fields as error
status number required