RealVNC Connect provides APIs for managing your RealVNC Connect team. To enable APIs for your RealVNC Connect subscription please contact our Sales team.
Access to the APIs is controlled by an API Access Key, which team Managers, Admins and Owners can create and manage in the RealVNC Connect Portal.
Managing API Access Keys
API Access Keys are managed on the API Access Keys page of the RealVNC Connect Portal, which is found in the Addons section.
A list of existing API Access Keys will be displayed including the permissions that the key grants, the expiry date of the key (optional), a user-friendly label and the status of the key (Active/Revoked).
Note: it is not possible to retrieve the Access Key/secret itself, it is only displayed when the Access Key is created.
Creating an API Access Key
To create an API Access Key, navigate to the API Access Keys page of the RealVNC Connect Portal and click the Create Access Key button.
A popup will be displayed that allows you to choose the permissions that you would like the Access Key to have, a label and optionally set an expiry. For a definition of what each permissions means, click here.
You will then be provided with the Access Key ID and the Access Key itself. Make a note of your Access Key, it will not be displayed again and cannot be retrieved later.
The Access Key and Access Key ID are now ready to use with the RealVNC Connect APIs!
Make sure to keep your access key stored securely and privately, as it grants administrative privileges to your team.
Revoking an API Access Key
To revoke an Access Key, click the 3 dots to the right of the Access Key that you want to revoke, then click Revoke.
You will be asked to confirm the revocation. Once you click the Revoke button, the Access Key can no longer be used with the RealVNC Connect APIs. The Access Key will be shown in the table of Access keys in the portal, with Revoked shown in the Status column.
Removing an API Access Key
To revoke an Access Key, click the 3 dots to the right of the Access Key that you want to revoke, then click Remove. Note: removing an Access Key revokes it at the same time.
You will be asked to confirm the removal. Once you click the Remove button, the Access Key can no longer be used with the RealVNC Connect team management APIs and will be deleted from your list of Access Keys.
Using an API Access Key
For API documentation and an example script that demonstrates the capabilities of the RealVNC Connect's APIs, click here.