API users

API users

The API keys used to interact with BlackNoise


Only users with the Administrator role can manage API keys within their organization.



API tokens list

The list shows, for each token: token name, truncated API key value, creation date, and date of last API request. It can be exported as a .csv file.


Create an API token

    Click Create API user.
    Enter the token name.
    Save.
The web app then shows the complete API key value. Copy and store it securely — you need it to use the API, and the full value is never shown again. Clicking a token later shows only the truncated value.


Modify an API token

When editing a token you can:
  • Regenerate the key with Generate new key; the current key is revoked and a new one is issued.
  • Disable the token with the User active toggle; it can no longer connect, but it is kept for later reactivation.
  • Delete the token with the Delete API user button; all information is removed.
Click Save to apply the changes.