Ensure a stream. - S2

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>"
}

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

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.

Show child attributes

retention_policy

object

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

Option 1
Option 2

Show child attributes

storage_class

string | null

Storage class for recent writes.

timestamping

null | object

Timestamping behavior.

Show child attributes

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.