Return to Knowledge Base homepage

How to Get a photoSentinel API Key

You can get a photoSentinel API key any time from Control Hub, to use with the photoSentinel Utilities app or for integrations with your own software.

To get an API Key, you will first need user permission to generate, disable and delete API keys.

Any user who has permission to Manage Users will have the ability to enable API key management for another user.

Enable API Access

You must have permission to Manage Users on your user account to enable API key management for another user. This will give the selected user the ability to generate, disable and delete API keys.

1. Login to Control Hub
2. Click on the Management - Users tab
3. Locate the desired user from the list or by using the search bar
4. Click on the Manage hyperlink
5. Scroll down to their User Permissions section
6. Click on the box for API access enabled
7. Click on the Save Changes button

The selected user will now be able to generate, disable and delete API keys.

How to Generate, Disable, and Delete API Keys

Once a user has API access enabled, they can perform any of the following functions.

Generate an API Key

1. Login to Control Hub
2. Click on your user profile drop-down menu in the top right of the page, then click on My Details
3. Scroll down to the API Keys section
4. Click the Generate New Key + button
5. Click the Save Changes button

You can now return to this page anytime to copy and paste the API key for integrations.

Disable or Re-enable an API Key

You can disable, rather than delete, an API key if you only want to stop using it temporarily, and re-enable it anytime.

1. Login to Control Hub
2. Click on your user profile drop-down menu in the top right of the page, then click on My Details
3. Scroll down to the API Keys section
4. To disable an API key temporarily, un-tick the box in the Enabled column of the desired API key
5. To re-enable the desired API key instead, tick the box.
6. Click the Save Changes button

The selected API key will now be disabled (or re-enabled, if you ticked the box instead).

Delete an API Key

1. Login to Control Hub
2. Click on your user profile drop-down menu in the top right of the page, then click on My Details
3. Scroll down to the API Keys section
4. NOTE: Once you delete a key, it cannot be recovered. Click the Delete Key button next to the API key you want to remove.

The selected API key has now been deleted.

Lodge a Support Ticket

If this article did not resolve your issue, please lodge a Support ticket.