Skip to main content

Catalog App Desktop Aliases

GET /catalog-apps/{catalog_app_id}/desktop-aliases

Returns a paginated list of desktop aliases associated with a specific catalog app. Desktop aliases are the process names or application identifiers the system uses to match observed desktop activity to a catalog application (e.g. chrome.exe, Google Chrome, chrome).

Path Parameters

ParameterTypeDescription
catalog_app_idstring (uuid)Unique identifier for the catalog app

Query Parameters

ParameterTypeDefaultDescription
qstring-Search filter against alias (case-insensitive, partial match)
sort_bystringaliasSort field: alias, created_at
sort_orderstringascSort direction: asc, desc
page_sizeinteger50Items per page. Max: 500
cursorstring-Pagination cursor from a previous response

Response

FieldTypeDescription
dataDesktopAlias[]Array of desktop alias objects
total_countintegerTotal number of desktop aliases for this catalog app
next_cursorstring | nullCursor to pass as cursor for the next page. null when on the last page.

Example Request

curl -X GET "https://api.example.com/v2/catalog-apps/a1b2c3d4-e5f6-7890-abcd-ef1234567890/desktop-aliases" \
-H "Authorization: Bearer YOUR_API_TOKEN"

Example Response

{
"data": [
{
"id": "44556677-8899-aabb-ccdd-eeff00112233",
"alias": "chrome"
},
{
"id": "55667788-99aa-bbcc-ddee-ff0011223344",
"alias": "chrome.exe"
},
{
"id": "66778899-aabb-ccdd-eeff-001122334455",
"alias": "Google Chrome"
}
],
"total_count": 3,
"next_cursor": null
}

Pagination

This endpoint uses cursor-based pagination.

  1. Omit cursor on the first request
  2. If next_cursor is not null, pass its value as cursor on the next request
  3. Repeat until next_cursor is null

Error Responses

StatusDescription
400Invalid query parameters (e.g. unknown sort_by value)
401Authentication required
403Insufficient permissions
404Catalog app not found
500Server error

Example Error Response

{
"error": {
"code": "not_found",
"message": "Catalog app not found",
"details": {
"catalog_app_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}
}