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

Alias List

Returns a paginated list of stream key aliases for an application.

Request

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

Path Parameters

Parameter Type Required Description
appName string Yes Application name

Query Parameters

Parameter Type Required Default Description
page integer No 1 Page number
rowsPerPage integer No 10 Number of items per page
orderBy string No - Field name to sort by
order "asc" | "desc" No - Sort order
search string No - Filter by alias key

Response

Status Codes

Code Description
200 Success
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 (200)

{
  "data": {
    "totalItems": 1,
    "itemsPerPage": 10,
    "totalPages": 1,
    "currentPage": 1,
    "hasPrevious": false,
    "hasNext": false,
    "list": [
      {
        "aliasKey": "omen",
        "streamKey": "domen",
        "isPermanent": true,
        "streamExists": false
      }
    ]
  },
  "meta": {
    "executionTime": 2,
    "generatedAt": 1766062027302
  }
}

Response Body

Pagination

Parameter Type Description
data.totalItems integer Total number of aliases
data.itemsPerPage integer Number of items per page
data.totalPages integer Total number of pages
data.currentPage integer Current page number
data.hasPrevious boolean Indicates if a previous page exists
data.hasNext boolean Indicates if a next page exists

Alias Object

Parameter Type Description
data.list[].aliasKey string Alias key
data.list[].streamKey string Target stream key that the alias points to
data.list[].isPermanent boolean Indicates if the alias is permanent
data.list[].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 Response (4xx/5xx)

{
  "message": "Error message"
}

Error Response Body

Parameter Type Description
message string Human-readable error message