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

Alias Create

Creates a new stream key alias for an application. Can also be used to overwrite an existing alias.

Request

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

Path Parameters

Parameter Type Required Description
appName string Yes Application name

Request Body

Parameter Type Required Description
data.attributes.aliasName string Yes Alias key (alternative name for the stream)
data.attributes.streamKey string Yes Target stream key that the alias points to

Example Request

{
  "data": {
    "attributes": {
      "aliasName": "aliasName",
      "streamKey": "streamKey"
    }
  }
}

Response

Status Codes

Code Description
201 Created - Alias successfully created
400 Bad Request - Invalid parameters
401 Unauthorized - Invalid or missing token
404 Not Found - Application does not exist
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error

Successful Response (201)

{
  "data": {
    "attributes": {
      "aliasName": "aliasName",
      "streamKey": "streamKey",
      "isPermanent": true,
      "streamExists": false
    }
  },
  "meta": {
    "executionTime": 13,
    "generatedAt": 1766063439641
  },
  "message": "New Alias has been added"
}

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
message string Response status message

Metadata

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

Error Responses

Application Not Found (404)

{
  "message": "Application not found"
}

Error Response Body

Parameter Type Description
message string Human-readable error message