Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

Name of the stream to create

​
description
string

Description of the stream

​
subjects
string[]

Subject patterns to capture

​
max_consumers
integer

Maximum number of consumers

Required range: x >= 1
​
max_msgs
integer

Maximum number of messages

Required range: x >= 1
​
max_bytes
integer

Maximum size in bytes

Required range: x >= 1
​
discard
enum<integer>
default:0

Discard policy (0 = old, 1 = new)

Available options:
0,
1
​
max_msgs_per_subject
integer

Maximum messages per subject

Required range: x >= 1
​
max_msg_size
integer

Maximum message size in bytes

Required range: x >= 1
​
storage
enum<string>
Available options:
file,
memory
​
num_replicas
integer
default:1

Number of replicas

Required range: x >= 1
​
mirror
object
​
sources
object[]

Optional sources configuration

​
sealed
boolean
default:false

Whether the stream is sealed

​
deny_delete
boolean
default:false

Whether deletes are denied

​
deny_purge
boolean
default:false

Whether purges are denied

Response

Bad Request

​
message
string
Example:

"success"