Can I launch RealVNC Viewer from a link on a web page or program using URIs?

Follow

Yes! Starting in version 6.22.826 onwards, RealVNC Viewer installs a URI handler that can be called from other programs, like web browsers, to launch a connection to a RealVNC Server using RealVNC Viewer.

What connection string format does the URI use?

The connection string format to launch a connection using a URI is below. The URI handler does not accept any additional parameters other than the RealVNC Server address.

Cloud Connections

com.realvnc.vncviewer.connect://<cloud server ID>

Direct Connections

com.realvnc.vncviewer.connect://<hostname|ip[v6]>[:<port>]

Direct connections are only available on certain subscriptions.

How do I find connection address(es) for my RealVNC Server?

You can find the connection information for RealVNC Server both through the GUI and at the command line.

Using the RealVNC Server GUI

To find the connection address(es) using the RealVNC Server GUI, first open the RealVNC Server GUI using either the Start/Applications menu, or by double-clicking the RealVNC Server icon in the taskbar.

Once the GUI opens, expand the Other ways to connect section which will list the cloud server ID (all subscriptions) and/or IP address(es) (subscriptions that include direct connections).

OtherWaysToConnect.png

Using the command line

Starting in version 6.11.0 you can query RealVNC Server for the cloud server ID on the command line. To do so, look for the ServerId line after running the appropriate command for your platform below.

Windows (elevated/administrator access required)

"C:\Program Files\RealVNC\VNC Server\vncserver.exe" -service -cloudstatus

Mac

sudo /Library/vnc/vncserver -service -cloudstatus

Linux

sudo vncserver-x11 -service -cloudstatus
Was this article helpful?
2 out of 8 found this helpful

Comments

6 comments
  • This doesn't work on mobile. What is the URI to launch the mobile version? (even if it doesn't include a specific connection)

    0
    Comment actions Permalink
  • I'm using VNC Viewer v7.0.1 with an enterprise account on Win10 Pro.
    Using a formatted link like this
    com.realvnc.vncviewer.connect://example.IP.addr.here:5900
    doesn't do anything. What am I missing?
    Do I need to enable the VNC Viewer URL handler?

    0
    Comment actions Permalink
  • Hi Rob,

    Apologies for the late reply. The RealVNC Viewer mobile apps should work with the same format. Are you seeing any errors when trying to launch the apps via URI?

    0
    Comment actions Permalink
  • Hi Bryan,

    The URI is installed as part of the RealVNC Viewer installation package - note that the "standalone" RealVNC Viewer won't install the URI handler to your system.

    Your connection string looks correct, how are you trying to launch it? e.g. as a link on a webpage?

    Thanks,

    Jack

    0
    Comment actions Permalink
  • On Android, I got this working by using "vnc" as the scheme. So "vnc://{ip/host}:{port}". Maybe the desktop also has a handler for it?

    It would be nice to be able to pass in the password as a param, though. Is that possible?

    1
    Comment actions Permalink
  • Can we specify "username" and "password" in the URI?
    That would be really convenient for the user.

    1
    Comment actions Permalink

Please sign in to leave a comment.