Team Management APIs - managing API Access Keys

Follow

VNC Connect provides APIs for managing your team's devices. To enable APIs for your VNC 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 VNC Connect portal.

Managing API Access Keys

API Access Keys are managed on the API Access Keys page of the VNC Connect portal. 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.

accesskey1.png

Creating an API Access Key

To create an API Access Key, navigate to the API Access Keys page of the VNC Connect portal and click the Create Access Key button.

accesskey1a.png

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.

accesskey5.PNG

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.

Make sure to keep your access key stored securely and privately, as it grants administrative privileges to your team.

accesskey7.PNG

The Access Key and Access Key ID are now ready to use with the VNC Connect team management APIs!

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.

accesskey2a.png

You will be asked to confirm the revocation. Once you click the Revoke button, the Access Key can no longer be used with the VNC Connect team management APIs. The Access Key will be shown in the table of Access keys in the portal, with Revoked shown in the Status column.

accesskey3.PNG

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.

accesskey2b.png

You will be asked to confirm the removal. Once you click the Remove button, the Access Key can no longer be used with the VNC Connect team management APIs and will be deleted from your list of Access Keys.

accesskey4.PNG

Using an API Access Key

For API documentation and an example script of the API functionality, click here.

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.