Products Solutions Developer Pricing Get For Free Download Sign in Sign up
Show topics

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

Path Parameters

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

Response

Status Codes

Code Description
200 Success
401 Unauthorized - Invalid or missing token
404 Not Found - Application or alias does not exist
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error

Successful Response (200)

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

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)

Error Responses

Alias Not Found (404)

{
  "message": "Alias not found"
}

Error Response Body

Parameter Type Description
message string Human-readable error message