Streams

Create or update a stream

Changed on

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}

Request

Path parameters

namestring required

Name of the stream

Request body

descriptionstring

Updated description of the stream

max_msgsinteger

Updated maximum number of messages

max_bytesinteger

Updated maximum size in bytes

max_msg_sizeinteger

Updated maximum message size in bytes

Response

Bad Request

messagestring

Example response

{
  "message": "success"
}

Changes

    • warning

      the request property's min was set to 1.00

    • warning

      the request property's min was set to 1.00

    • warning

      the request property's min was set to 1.00

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      the request property format was generalized from int64 to no format

    • info

      the request property format was generalized from int32 to no format

    • info

      the request property format was generalized from int64 to no format

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      removed the Success enum value from the response property for the response status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      the endpoint scheme security bearerAuth was removed from the API

    • info

      added the optional property to the response with the status