Cluster Alias Create

Creates a new stream alias in the cluster.

Request

Property	Value
Method	`POST`
URL	`/api/cluster/aliases`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X POST "{BASE_URL}/api/cluster/aliases" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"data":{"attributes":{"aliasName":"alias","streamKey":"test"}}}'

Request Body

Parameter	Type	Required	Description
`data.attributes.aliasName`	string	Yes	Name for the new alias
`data.attributes.streamKey`	string	Yes	Stream key to associate the alias with

Request Body

json

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

Response Body

Parameter	Type	Description
`data.attributes.streamKey`	string	Stream key associated with the alias
`data.attributes.aliasName`	string	Name of the created alias
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)
`message`	string	Response status message

Successful Response (200)

json

{
  "data": {
    "attributes": {
      "streamKey": "test",
      "aliasName": "alias"
    }
  },
  "meta": {
    "executionTime": 49,
    "generatedAt": 1771957168096
  },
  "message": "New Alias has been added"
}

Error Response (4xx/5xx)

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

Error Response

json

{
  "message": "Error message"
}

Support Needed?

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