Skip to main content
PATCH
Reconfigure a stream.

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
null | 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
null | object

Timestamping behavior.

Response

delete_on_empty
null | 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
null | object

Timestamping behavior.