API Keys
API keys let other applications or scripts access Burdenoff on your behalf. They are useful for integrations, automations, and developer workflows.
What Are API Keys?
An API key is a secure token that identifies your account to Burdenoff when using external tools or scripts. Instead of signing in with your password, the tool uses the key to prove it has permission to act as you.
Why This Matters
Using API keys is safer than sharing your password. You can create separate keys for different tools and revoke them individually if needed.
Creating an API Key
Steps to Create a Key
- Sign in to Burdenoff.
- Go to Account Settings.
- Navigate to the API Keys section.
- Click Create New Key.
- Give the key a clear name so you know what it is for (for example, "Zapier Integration" or "Internal Scripts").
- Choose the permissions or scopes the key should have. Only grant what is necessary.
- Click Generate Key.
- Copy the key and store it securely. For security reasons, you will only see the full key once.
Why Naming and Scopes Matter
A clear name helps you remember what the key is for. Limiting permissions reduces the risk if the key is ever exposed.
Managing Your API Keys
You can view and manage all your API keys from the same settings page.
Steps to Review Keys
- Go to Account Settings > API Keys.
- You will see a list of your active keys with their names, creation dates, and last used times.
Rotating a Key
If a key is old or you suspect it may have been exposed, you should replace it.
- Create a new key with the same permissions.
- Update your tool or script to use the new key.
- Revoke the old key.
Revoking an API Key
If you no longer need a key or think it has been compromised, revoke it immediately.
Steps to Revoke a Key
- Go to Account Settings > API Keys.
- Find the key you want to remove.
- Click Revoke.
- Confirm the action.
What Happens Next
Any tool or script using that key will stop working. Make sure you update integrations with a new key before revoking the old one, unless you believe the key has been stolen.
What to Do If You Suspect a Key Is Compromised
- Revoke the key immediately.
- Check your account activity for any unusual actions.
- Rotate any other keys that may be related.
- Report the issue to your workspace administrator if you are part of an organization.
Quick Tips
- Never share API keys in emails, chat messages, or public repositories.
- Treat API keys like passwords: store them securely and rotate them regularly.
- Only grant the minimum permissions needed for each integration.