Skip to main content
PATCH
/
streams
/
{stream}
Reconfigure a stream.
curl --request PATCH \
  --url https://{basin}.b.s2.dev/v1/streams/{stream} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "delete_on_empty": {
    "min_age_secs": 1
  },
  "retention_policy": {
    "age": 1
  },
  "storage_class": "standard",
  "timestamping": {
    "mode": "client-prefer",
    "uncapped": true
  }
}

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

​
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.