Create or update a stream

Creates a new stream or updates an existing stream with the provided configuration. If the stream does not exist, it will be created. If it exists, it will be updated with the new configuration.

Note that some properties cannot be changed after a stream is created, such as the storage type. If you attempt to change these properties, the request will fail with a 400 error.

PUT /storage/streams/{name}

cURL

update_description

curl --request PUT \
  --url https://api.quiva.ai/storage/streams/{name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Updated description for the user events stream"
}
'

200

{
  "message": "success"
}

Authorizations

bearerAuthapiKeyAuth

Authorization · string · header · required

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

Path Parameters

name · string · required

Name of the stream

Body

application/json

description · string

Updated description of the stream

max_msgs · integer

Updated maximum number of messages

Required range: x >= 1

max_bytes · integer

Updated maximum size in bytes

Required range: x >= 1

max_msg_size · integer

Updated maximum message size in bytes

Required range: x >= 1

Response

200

application/json

Bad Request

message · string

Example:

"success"