Viewing Your API Keys
The API Keys page displays all your active keys with the following information:| Field | Description |
|---|---|
| Name | The descriptive name you assigned to the key |
| Key Prefix | A masked preview showing only the key prefix (e.g., ksa_****) |
| Created | When the key was created |
| Last Used | When the key was last used for an API request |
| Expires | The expiration date, if one was set |
| Status | Visual badges indicating if a key is Expired or Expiring soon |
Creating an API Key
Enter a Name
Provide a descriptive name to help you identify this key (e.g., “Production Server”, “CI/CD Pipeline”, “Local Development”)
Set Expiration (Optional)
Click the date picker to set an expiration date for the key. If left empty, the key will never expire.
Viewing API Key Usage
Monitor how your API keys are being used:
The usage dialog displays:
| Metric | Description |
|---|---|
| Total Requests | All-time number of API requests made with this key |
| Requests Today | Number of requests made in the current day |
| This Month | Number of requests made in the current month |
| Last Used | The exact date and time the key was last used |
Regenerating an API Key
If you suspect a key has been compromised or need to rotate keys:Deleting an API Key
Using API Keys
Include your API key in theX-API-Key header when making requests:
Best Practices
- Use descriptive names - Name keys after their purpose (e.g., “GitHub Actions CI”, “Production Backend”)
- Set expiration dates - For temporary access or compliance requirements, set keys to expire
- Rotate regularly - Regenerate keys periodically to limit exposure if a key is compromised
- Monitor usage - Check usage statistics to detect unexpected activity
- Never commit keys - Store API keys in environment variables or secrets managers, never in code