5.1 Generate API keys

API keys belong to individual user accounts and inherit the same permissions as the associated account. If you want to your API key to have a different set of permissions than your user account, you can create a new user under which to generate the key. See 14.1 Create, edit, and delete users.

To create a new API key:

  1. Select Account from the main menu
  2. Select the API Keys sub menu
  3. Enter a valid, unused label for the key
  4. Click Generate New Key
  5. The new key will be displayed below the form and the key label, creation time, and last use time will be displayed in the Your API Keys table
    • For security reasons, the API key will only be displayed once and cannot be retrieved
    • If you lose the key you can revoke it and generate a new one

Please store your API Keys securely, such as in a password manager, and avoid publishing them in source code because they grant access to your account.

If a key is compromised or you wish to stop using the key you can revoke it using the following steps:

  1. Select Account from the main menu
  2. Select the API Keys sub menu
  3. In the Your API Keys table, locate the key you wish to revoke and click the rubbish bin icon in the Revoke column
  4. Click Delete in the confirmation dialogue to confirm the deletion