API Keys

Overview

ToBeAlert provides an API key management system that allows users to create keys used to authenticate requests to the API.

API keys Management

Creating API keys

Users can create an API key through the API keys interface:

1. Navigate to the Access Control section
2. Select the API keys tab
3. Click the "Create key" button
4. Fill in the required information:
   • Owner
   • Expiration date
   • Permissons
   • Description (optional)
5. Save the API key configuration

API key properties

Each API key includes the following properties:

Property	Description
Owner	Owner of the API key. the username will be registered in the history each time the key is used
Expiration date	The date on which the API key expires and is no longer usable
Permissions	The actions the API key is able to perform. More information on the Permission Categories section
Description	Additional information about the API key

Best practices

For secure and effective API key management:

1. Use descriptive key names – Identify the purpose and owner of each key at a glance
2. Grant minimal access – Limit each key’s permissions to only what’s necessary
3. Set expiration dates – Avoid long-lived keys by enforcing expiry when possible
4. Rotate keys regularly – Periodically generate new keys and retire old ones
5. Audit key usage – Monitor and review key activity for unusual behavior