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

Request

bash

curl -X POST "{BASE_URL}/api/applications/{appName}/aliases" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'

Path Parameters

Parameter	Type	Required	Description
`appName`	string	Yes	Application name

Request

bash

curl -X POST "{BASE_URL}/api/applications/{appName}/aliases" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

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

json

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

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)

Successful Response (201)

json

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

Error Responses

Application Not Found (404)

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

json

{
  "message": "Application not found"
}

Support Needed?

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