Generate an API Key

When you use the Data Extraction API, you enter URL queries that require the API Key for your N-sight account.

https://{SERVER}/api/?apikey={yourAPIkey}&service=service_name&parameter=xxx

The API Key is used to authenticate against the Public API. If you regenerate a new key, anything using the existing key to authenticate against the Public API stops working.

👍

If you already have an API Key, we recommend you use it.

If the Agent Key is assigned to a client group that contains no clients or a subset of clients, API calls made using the generated API Key can only return data associated with the clients in the assigned client group.

Where security requires that the Agent Key access to client information within N-sight must be restricted, we recommend that the Agent Key Access is revoked.

To generate the API Key to query the N-sight system:

1. Log in to N-sight as a Superuser or (non-Classic) Administrator level access, or using a login with the required General permissions enabled, or using the Agent Key (if enabled).
2. In the All Devices view, go to Settings > General Settings > API.
3. Select Generate (or Regenerate when you are creating a new API Key) and record the API Key for future use.
4. Enter the recipient email address in the Email API Token to (optional) field and click Email Token to (Optional).
5. The sent email includes the API Key and the server URL to query.
6. Select OK to apply.

👍

You can generate the API Key as often as required. Each regeneration overwrites the existing key.