Stream management API

Open

The Stream management API enables external applications to interact with stream resources in UsageCloud. Use this API to programmatically manage streams, retrieve configurations, and work with stream versions for backup, audit, or integration purposes.

With the Stream management API, you can:

List streams

• Retrieve a paginated list of all streams in your solution, filtered by name, associated resources (collectors, meters, and aggregation stores), or solution ID.

Get stream configuration

• Retrieve the complete configuration and metadata for a specific stream, including nodes, edges, node groups, and HTTP endpoints for receiving data. Optionally specify which fields to return or retrieve a particular tagged version.

List stream versions

• View the complete version history for a stream, including all tagged versions and the current autosaved version.

Export stream

• Export the JSON representation of any stream version for backup, migration, or audit purposes. Specify a version tag or export the current version.

Import stream

• Import a complete stream configuration into a solution to create a new stream or update an existing one, with support for tagged versions, conflict resolution strategies for name collisions, and optional node deletions when overwriting existing streams. You can use this endpoint to import streams into any account for which you have an application access token, for example, to move configurations from a development environment to production. For more information, see Streams.

Deploy stream

• Deploys a requested tagged version of one or more streams in a solution. See Deploying a stream or stream group for more information.

Undeploy stream

• Undeploys a requested tagged version of one or more streams in a solution. See Undeploying a stream or stream group for more information.

Start stream

• Start a stream run of the currently deployed tagged version of the stream. If no tagged version is deployed, the stream will run the latest version of the stream, including the Autosaved version. The stream run starts immediately with the current timestamp, while recording the tagged version and a unique execution identification of the run.

Stop stream

• Stop an actively running stream that was started.

Start stream group

• Start a stream deployment group. All streams in the group are prepared before the group is triggered. The streams are executed sequentially.

Stop stream group

• Stop a running stream deployment group. Any running streams in the group are stopped.

Resume stream group

• Resume a stopped stream deployment group from its last checkpoint. Any running streams in the group are stopped.

Get stream stats

• Return runtime statistics for streams. Supports optional filtering by solution, stream group, individual stream, or status. Returns a flat list of stream status objects including deployment phase, uptime, I/O counts, and group membership. All status values are in lowercase.

Access and security

Access to the Stream management API is secured. An admin user must first create an Application access with the Stream management scope. For more information on setting up APIs and links to the API documentation, see our API access guide.