Skip to main content
PUT
/
streams
/
{stream}
Create or reconfigure a stream.
curl --request PUT \
  --url https://{basin}.b.s2.dev/v1/streams/{stream} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "cipher": "aegis-256",
  "deleted_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://s2.dev/docs/llms.txt

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

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
stream
string
required

Stream name.

Required string length: 1 - 512

Body

application/json
​
delete_on_empty
object

Delete-on-empty configuration.

​
retention_policy
object

Retention policy for the stream. If unspecified, the default is to retain records for 7 days.

​
storage_class
null | enum<string>

Storage class for recent writes.

Available options:
standard,
express
​
timestamping
object

Timestamping behavior.

Response

​
created_at
string<date-time>
required

Creation time in RFC 3339 format.

​
name
string
required

Stream name.

Required string length: 1 - 512
​
cipher
null | enum<string>

Encryption algorithm for this stream, if encryption is enabled.

Available options:
aegis-256,
aes-256-gcm
​
deleted_at
string<date-time> | null

Deletion time in RFC 3339 format, if the stream is being deleted.