Skip to main content
POST
/
api
/
v1
/
streams
/
fields
Create a field given a existing stream name in clickhouse database
curl --request POST \
  --url https://cloud.bytebeam.io/api/v1/streams/fields \
  --header 'Content-Type: application/json' \
  --header 'x-bytebeam-api-key: <api-key>' \
  --header 'x-bytebeam-tenant: <api-key>' \
  --data '
{
  "fieldName": "<string>",
  "fieldType": "UInt8",
  "streamName": "<string>",
  "fieldUnit": "<string>"
}
'
This response has no body data.

Documentation Index

Fetch the complete documentation index at: https://bytebeam.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-bytebeam-api-key
string
header
required

API key required to authenticate requests.

​
x-bytebeam-tenant
string
header
required

Tenant(Project) name required to identify the project.

Body

​
fieldName
string
required
​
fieldType
enum<string>
required
Available options:
UInt8,
DateTime64(3),
Nullable(String),
Float64,
Nullable(Int8),
Nullable(Bool),
Nullable(Int64),
Int8,
UInt16,
Int16,
Nullable(UInt64),
DateTime64(6),
Date,
Nullable(Date),
Nullable(DateTime64(3)),
Nullable(Float64),
Nullable(Array(String)),
Nullable(UInt32),
Array(String),
Bool,
Int64,
UInt32,
String,
Nullable(DateTime64(6)),
Nullable(Float32),
Nullable(Int32),
Nullable(UInt8),
Int32,
Nullable(Int16),
Nullable(UInt16),
Nullable(DateTime),
Float32,
DateTime,
UInt64
​
streamName
string
required
​
fieldUnit
string | null

Response

default - undefined