Alias

Returns detailed information about a specific stream key alias.

Request

Property	Value
Method	`GET`
URL	`/api/applications/{appName}/aliases/{aliasName}`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X GET "{BASE_URL}/api/applications/{appName}/aliases/{aliasName}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Path Parameters

Parameter	Type	Required	Description
`appName`	string	Yes	Application name
`aliasName`	string	Yes	Alias key

Request

bash

curl -X GET "{BASE_URL}/api/applications/{appName}/aliases/{aliasName}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response Body

Alias Object

Parameter	Type	Description
`data.attributes.aliasName`	string	Alias key (alternative name for the stream)
`data.attributes.streamKey`	string	Target stream key that the alias points to
`data.attributes.isPermanent`	boolean	Indicates if the alias is permanent
`data.attributes.streamExists`	boolean	Indicates if the target stream currently exists

Metadata

Parameter	Type	Description
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)

Successful Response (200)

json

{
  "data": {
    "attributes": {
      "aliasName": "omen",
      "streamKey": "domen",
      "isPermanent": true,
      "streamExists": false
    }
  },
  "meta": {
    "executionTime": 0,
    "generatedAt": 1766061887431
  }
}

Error Responses

Alias Not Found (404)

Parameter	Type	Description
`message`	string	Human-readable error message

json

{
  "message": "Alias not found"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.