Cluster Alias

Returns detailed information about a specific stream alias.

Request

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

Request

bash

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

Path Parameters

Parameter	Type	Required	Description
`aliasName`	string	Yes	The alias name

Request With Parameters

bash

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

Response Body

Parameter	Type	Description
`data.attributes.streamKey`	string	Stream key associated with the alias
`data.attributes.aliasName`	string	Alias name
`data.attributes.streamExists`	boolean	Indicates if the associated stream exists
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)

Successful Response (200)

json

{
  "data": {
    "attributes": {
      "streamKey": "test",
      "aliasName": "alias",
      "streamExists": false
    }
  },
  "meta": {
    "executionTime": 0,
    "generatedAt": 1771957542583
  }
}

Error Response (4xx/5xx)

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

Alias Not Found (404)

json

{
  "message": "Alias not found"
}

Error Response

json

{
  "message": "Error message"
}

Support Needed?

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