Ensure 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"
}{
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"cipher": "aegis-256",
"deleted_at": "2023-11-07T05:31:56Z"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}streams
Ensure a stream.
Ensure an S2 stream exists with the specified configuration. If it already exists, only its configuration is updated.
PUT
/
streams
/
{stream}
Ensure 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"
}{
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"cipher": "aegis-256",
"deleted_at": "2023-11-07T05:31:56Z"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
Path Parameters
Stream name.
Required string length:
1 - 512Body
application/json
Delete-on-empty configuration.
Show child attributes
Show child attributes
Retention policy for the stream. If unspecified, the default is to retain records for 7 days.
- Option 1
- Option 2
Show child attributes
Show child attributes
Storage class for recent writes.
Available options:
standard, express Timestamping behavior.
Show child attributes
Show child attributes
Response
Creation time in RFC 3339 format.
Stream name.
Required string length:
1 - 512Encryption algorithm for this stream, if encryption is enabled.
Available options:
aegis-256, aes-256-gcm Deletion time in RFC 3339 format, if the stream is being deleted.