Skip to main content

API Key Management

API keys are used to authenticate and connect to Jet Analytics API endpoints. An API key grants access to your organisation's resources within the key's scope. A maximum of five API keys can be generated per organisation.

Create a new API key

  1. In the Jet Analytics Portal, navigate to Admin > Security and permissions.
  2. Click Create API Key.
  3. Enter a Name for the API key.
  4. Click Generate API Key.
  5. Click Copy and save the key in a secure location. The key will not be shown again after this dialog is closed.
  6. Click Close to return to the Security and permissions page.

Delete an API key

Deleting an API key is permanent and cannot be undone. Deleted keys can no longer be used to authenticate.

  1. In the Jet Analytics Portal, navigate to Admin > Security and permissions. Click the delete icon next to the API key to delete.
  2. Type the Name of the API key to confirm deletion, or click in the field and select from the dropdown.
  3. Enter a Comment stating the reason for deletion. This is recorded in the activity log under Admin > Activities.
  4. Click Delete to confirm.

Was this article helpful?

We're sorry to hear that.