Skip to main content

Deep linking to the Comet Management Console

Deep links are shareable URLs that open the Comet Management Console at a specific location, such as a user's Devices tab, a Protected Item, or a Storage Vault. A deep link can also open an action dialog, for example the Run Backup or Restore dialog for an online device.

Deep links are useful for integrations. An RMM or PSA tool, a support ticket, or a saved bookmark can embed a deep link that takes a technician directly to the relevant item in the Management Console.

Deep links are plain hash-fragment URLs into the existing web console. There is no custom comet:// protocol; a deep link opens the Management Console in the browser at the requested location.

Deep linking was introduced in Comet 26.4.5 "Phoebe" and 26.5.2 "Voyager". The full set of routes described below is most reliable on Comet 26.5.x and later.

You do not need to build these URLs by hand. Navigate to the target in the Management Console and the browser's address bar shows the deep-link URL for that location. Copy it and embed it wherever you need it.

URL format

A deep link has the following base format:

<console-URL>#/<route>

<console-URL> is the address of your Comet Management Console, and <route> is one of the routes listed below.

The tables below cover the main deep-linkable routes. The format follows the Management Console's own URLs, so if you are unsure of the exact route for a location, navigate there in the console and copy the URL from the address bar.

Route reference

Administrator routes

The following routes target the administrator view of the Management Console.

Devices

TargetURL
A user's Devices tab<console-URL>#/users/<username>/devices
A specific online device (opens its action dialog)<console-URL>#/users/<username>/devices/<deviceId>
A device's action dialog, opened to Run Backup<console-URL>#/users/<username>/devices/<deviceId>/run-backup
A device's action dialog, opened to Restore<console-URL>#/users/<username>/devices/<deviceId>/restore

Protected Items

TargetURL
A user's Protected Items tab<console-URL>#/users/<username>/protected-items
The edit dialog for a specific Protected Item<console-URL>#/users/<username>/protected-items/<sourceGuid>
The edit dialog, opened on a specific tab<console-URL>#/users/<username>/protected-items/<sourceGuid>/<tab>

Storage Vaults

TargetURL
A user's Storage Vaults tab<console-URL>#/users/<username>/storage-vaults
The edit dialog for a specific Storage Vault<console-URL>#/users/<username>/storage-vaults/<vaultId>
The edit dialog, opened on a specific tab<console-URL>#/users/<username>/storage-vaults/<vaultId>/<tab>
The "Add new custom Storage Vault" dialog<console-URL>#/users/<username>/storage-vaults/new-custom
The add-new dialog, opened on a specific tab<console-URL>#/users/<username>/storage-vaults/new-custom/<tab>

Live Connections

TargetURL
The All Devices / Live Connections view for a device<console-URL>#/dispatch/<deviceId-or-connectionId>
The Live Connections view for a device, opened to Run Backup<console-URL>#/dispatch/<deviceId-or-connectionId>/run-backup
The Live Connections view for a device, opened to Restore<console-URL>#/dispatch/<deviceId-or-connectionId>/restore

End-user (self-service) routes

When a link is intended for an end user viewing their own self-service account, use the #/u/ routes instead. The username is not part of these URLs, because the route always applies to the signed-in user's own account.

Protected Items

TargetURL
The Protected Items page<console-URL>#/u/protected-items
The edit dialog for a specific Protected Item<console-URL>#/u/protected-items/<sourceGuid>
The edit dialog, opened on a specific tab<console-URL>#/u/protected-items/<sourceGuid>/<tab>

Storage Vaults

TargetURL
The Storage Vaults page<console-URL>#/u/storage-vaults
The edit dialog for a specific Storage Vault<console-URL>#/u/storage-vaults/<vaultId>
The edit dialog, opened on a specific tab<console-URL>#/u/storage-vaults/<vaultId>/<tab>
The "Add new custom Storage Vault" dialog<console-URL>#/u/storage-vaults/new-custom
The add-new dialog, opened on a specific tab<console-URL>#/u/storage-vaults/new-custom/<tab>

Dialog tabs

Where a route ends in <tab>, that segment selects which tab of the dialog is shown when it opens. The same tab names apply to both the administrator and self-service versions of the dialog.

For the Protected Item edit dialog:

<tab>Tab
generalGeneral
authAuthentication
itemsItems / selection
commandsCommands
scheduleSchedule
retentionRetention

For the Storage Vault edit and add-new dialogs:

<tab>Tab
generalGeneral
storageStorage
commandsCommands
encryptionEncryption
associated-devicesAssociated devices

Not every tab is available for every Protected Item or Storage Vault type. If the requested tab does not exist, or is hidden for that item, the dialog opens on its first available tab instead.

Behaviour

While an edit dialog is open, switching between its tabs updates the address bar to the matching <tab> route, so you can copy the link for the exact tab you are viewing.

Path segments such as the username are URL-encoded. Copying the link from the address bar (see above) handles this for you.

Deep links do not grant any additional access. The Management Console returns a 404 if the signed-in credential does not permit viewing the requested item.

If the technician is not logged in when they follow a deep link, the target location is stored and replayed automatically once they have signed in.