OPopenobserve
Streams

Get stream schema

Retrieves the schema definition for a specific stream, including field types and metadata. Supports filtering by keyword and pagination

get/api/{org_id}/streams/{stream_name}/schema

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.

keywordstring

Keyword filter for field names (default: empty)

offsetinteger

Pagination offset (default: 0)

limitinteger

Pagination limit (default: 0 = all)

Response

Success

inherited_retention_daysinteger nullable

Days the stream keeps data with no value of its own, 0 for forever; set by the schema read.

is_derivedboolean nullable
is_internalboolean

True for streams OpenObserve writes itself; omitted when false.

namestring required
storage_typestring required
stream_type'logs' | 'metrics' | 'traces' | 'profiles' | 'service_graph' | 'enrichment_tables' | 'file_list' | 'metadata' | 'index' required
total_fieldsinteger required

Changes

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