Streams

Update stream settings

Updates configuration settings for an existing stream, including retention policies, partitioning, and other stream-specific options

put/api/{org_id}/streams/{stream_name}/settings

Request

Path parameters

org_idstring required

Organization name

stream_namestring required

Stream name

Query parameters

typestring

Stream type. one of: logs, metrics, traces. Defaults to logs.

Request body

approx_partitionboolean nullable
data_retentioninteger nullable
dynamic_partitionboolean nullable

Whether the classifier decides the level; a value equal to the env's follows the env.

enable_distinct_fieldsboolean nullable
enable_log_patterns_extractionboolean nullable
flatten_levelinteger nullable
index_all_valuesboolean nullable
index_original_databoolean nullable
is_llm_streamboolean nullable
max_query_rangeinteger nullable
partition_time_level'unset' | 'hourly' | 'daily'
storage_type'normal' | 'compliance'
store_original_databoolean nullable

Response

Success

codeinteger required
error_detailstring nullable
hintstring nullable

One-line guidance on how to fix the error (agent self-correction, D4).

idstring nullable
messagestring required
namestring nullable
suggestionsstring[] nullable

Closest valid alternatives for a mistyped field/function name.

trace_idstring nullable
warningsstring[] nullable

Problems with a request that succeeded anyway. Distinct from hint, which explains a failure: these accompany a 200, and the caller is entitled to have meant it.

Changes

No recorded changes to this operation across all 1 revision of this API.