Stream Key Alias Settings

The <StreamKeyAliasSettings> block enables dynamic stream key resolution, allowing viewers to access streams using alternative names (aliases) instead of the original stream keys.

Available in: mono, edge

Sample Configuration

StreamKeyAliasSettings block

xml

<StreamKeyAliasSettings enabled="true">
    <AliasAutoDiscovery enabled="true">
        <RequestURL>https://api.example.com/alias/{aliasName}</RequestURL>
        <XApiKey>your-api-key-here</XApiKey>
        <AliasExpireTime>300</AliasExpireTime>
    </AliasAutoDiscovery>
</StreamKeyAliasSettings>

Parameters

Parameter	Description	Default
`StreamKeyAliasSettings:enabled`	Master switch for all alias functionality (both auto-discovery and cluster-managed aliases).	`false`

AliasAutoDiscovery

Automatic alias discovery resolves alias names to actual stream keys via an external API call. When a viewer requests a stream using an alias, Storm queries the configured endpoint to determine the real stream key.

Parameter	Description	Default
`AliasAutoDiscovery:enabled`	Enables automatic alias discovery via API.	`false`
`<RequestURL>`	API endpoint for alias resolution. Use `{aliasName}` as a placeholder for the alias name.	—
`<XApiKey>`	API authentication key, sent as `X-Api-Key` header with each request.	—
`<AliasExpireTime>`	Cache expiration time in seconds for auto-discovered aliases.	—

Cluster-Managed Aliases

When the master enabled attribute is set to true, cluster-managed aliases are automatically enabled as well. These aliases are created and managed by the cluster's supervisor (ClusterManager) and do not expire. They are distinct from auto-discovered aliases, which rely on an external API and use cache-based expiration.

Environment Variables

All parameters support environment variables using the ${EV:VARIABLE_NAME} syntax. Fields locked by environment variables cannot be modified via the REST API.

Support Needed?

If you have any questions or need assistance, please create a support ticket and our team will help you.