RealVNC Connect provides APIs for managing your team's devices. To enable APIs for your RealVNC Connect subscription you will need to contact our Sales team.
API documentation
Click here to access the RealVNC Connect API documentation.
Example script
Powershell |
Download |
You can use this Powershell script for a demonstration of the capabilities of the RealVNC Connect APIs. To use it, you need to have API Access enabled for your RealVNC Connect subscription and an API Access Key.
Note, the script is provided purely for sample purposes and is not supported by RealVNC. Exercise caution when using this script as it may modify your RealVNC Connect service.
| Usage | |
|---|---|
| -listcomputers [-lastseentime] [-entryid] [-csv] | Prints list of computer names in your Team to the console. If -lastseentime is specified then the last time the computer completed a daily check-in is included. If -entryid is specified then the entryId of the computer is included. If -csv is specified the information is output to Computers.csv in the script directory. Requires Access Key with LIST_ENTRIES permission |
| -renamecomputer "currentcomputername,newcomputername" | Renames the computer named currentcomputername to newcomputername. Names should be comma separated and enclosed in quotes. Requires Access Key with LIST_ENTRIES,UPDATE_ENTRY permissions |
| -renamecomputerlistbyname 'filename' | Renames the computer names in the file filename. The file must be in comma separated format currentcomputername,newcomputername - 1 per line. Requires Access Key with LIST_ENTRIES,UPDATE_ENTRY permissions |
| -findcomputer "computername" | Find the computer named computername in the Team. Name should be enclosed in quotes. Requires Access Key with LIST_ENTRIES permission |
| -removecomputer "computername" | Removes the computer named computername from the Team. Name should be enclosed in quotes. Requires Access Key with LIST_ENTRIES,DELETE_ENTRY permissions |
| -removecomputerlistbyname "filename" | Removes the computer names listed in the file filename. The file must have 1 computer name per line. Requires Access Key with LIST_ENTRIES,DELETE_ENTRY permissions |
| -removecomputerlistbyid "filename" | Removes the computer entryIDs listed in the file filename. The file must have 1 computer entryId per line. Requires Access Key with DELETE_ENTRY permission |
| -cleanduplicates "computername" | Finds all duplicated Computer entries for a given computer name prefix in the Team, removes all old/invalid entries and renames the working entry. Requires Access Key with LIST_ENTRIES,UPDATE_ENTRY,DELETE_ENTRY permissions |
| -cleanallduplicates | Finds all duplicated Computer entries in the Team, removes all old/invalid entries and renames the working entry. Requires Access Key with LIST_ENTRIES,UPDATE_ENTRY,DELETE_ENTRY permissions |
| -listcomputergroups | Prints list of computer group names to the console. Requires Access Key with LIST_ENTRY_GROUPS permission |
| -findcomputergroup "computergroupname" | Find the computer group named computergroupname in the Team. Name should be enclosed in quotes. Requires Access Key with LIST_ENTRY_GROUPS permission |
| -listgroupsforcomputer "computername" | Prints list of computer group names that the computer named computername belongs to. Name should be enclosed in quotes. Requires Access Key with LIST_ENTRY_GROUPS permission |
| -groupaddcomputer "computergroupname,computername" | Adds the computer named computername to the computer group named computergroupname. Names should be comma separated and enclosed in quotes. Requires Access Key with UPDATE_ENTRY_GROUP permission |
| -groupremovecomputer "computergroupname,computername" | Removes the computer named computername to the computer group named computergroupname. Names should be comma separated and enclosed in quotes. Requires Access Key with UPDATE_ENTRY_GROUP permission |
| -listauditevents [-daterange "startdate,enddate"] [-csv] | Prints list of audit events for your Team to the console. If -daterange is specified, the events are filtered to only display those between the specified dates. Dates should be comma separated and enclosed in quotes. If -csv is specified the information is output to Events.csv in the script directory. Requires Access Key with LIST_AUDIT_EVENTS permission |
Comments
Article is closed for comments.