/
Importing streams via API

Importing streams via API

You can import streams using the Stream management API. You send a complete stream configuration in JSON format and the target solution; the API then either creates a new stream or updates an existing one. For detailed API documentation and a guide to getting started with APIs, see the https://infozone.atlassian.net/wiki/x/qwJoDQ.

Creating a new stream via API

If the imported configuration refers to a stream that does not already exist in the solution (for example, a new name), the API creates a new stream based on the definition you provide. It appears in the Streams list of the solution like any other stream.

  • Without a tag: the imported configuration becomes the latest autosaved version.

  • With a tag: the import sets the current configuration of the stream and also adds a tagged entry in the version history, so you can clearly see and reuse the imported version later.

Replacing an existing stream via API

If the imported configuration refers to an existing stream, the API updates that stream instead of creating a new one.

  • Without a tag: the configuration overwrites the latest autosaved version of the stream.

  • With a tag: the API updates the autosaved version and then tags it.

The API supports conflict-resolution strategies when a stream with the same name already exists (for example, overwrite, create a new stream, or skip), and can optionally allow node deletions when overwriting a stream.

For more information on stream version tags and history, see https://infozone.atlassian.net/wiki/x/AYB2L.

Deleting stateful functions

When you use the import API with allowNodeDeletion enabled (so that nodes present in the existing stream but missing from the imported configuration are removed), stateful functions such as Data aggregator, Script aggregator, and functions that use persistent stores may leave behind orphaned state or behave differently depending on the function type. Orphaned state is no longer visible in the user interface and will eventually expire after its configured TTL. The state can be re-attached by deploying a previous stream version where the stateful node did exist. We recommend using node deletion with care in stateful production streams and always validating rollback and state access in a non‑production environment first.