This command creates secondary name(s) for group names. Once an alias is created the group name cannot be used to request HTTP playback of that stream. Once an alias is used (requested by a client) the alias is removed. Aliases are designed to be used to protect/hide your source streams.

API Parameter Table

Parameter Name Type Mandatory Default Value Description
groupName string true null The original group name
aliasName string true null The alias alternative to the group name

API Call Template

addGroupNameAlias groupName=<groupName> aliasName=<groupAliasName>

Sample API Call

addGroupNameAlias groupName=testAliasGroupName aliasName=testGroupAlias

Success Response in JSON

"description":"Alias applied to group name",

JSON Response

The JSON response contains the following details:

  • data – The data to parse
    • aliasName – The alias alternative to the localStreamName
    • groupName – The assigned groupName where alias is applied
  • description – Describes the result of parsing/executing the command
  • status – SUCCESS if the command was parsed and executed successfully, FAIL if not.


  • hasGroupNameAliases in webconfig.lua should be TRUE