Manage API keys
API keys let you authenticate requests to the Ferndesk API. You can create, view, and revoke keys from your account settings.
API keys grant full access to your workspace. Keep them secret and never commit them to version control.
Create an API key
To generate a new API key:
Click API in the left sidebar under Developers.
Click New API key.
Enter a descriptive name (e.g., "Production" or "CI/CD pipeline").
Click Create key.
Copy your key immediately. You won't be able to see it again after closing the dialog.
Store the key securely in your password manager or secrets vault.
View your API keys
All your API keys appear on the API page. You'll see the key name, creation date, and last-used timestamp—but not the key itself.
Revoke an API key
If a key is compromised or no longer needed:
Go to the API page.
Click the three-dot menu next to the key.
Select Revoke.
Revoking a key immediately blocks all requests using it. Any integrations or scripts will stop working until you update them with a new key.
Rotate your API keys regularly and revoke unused ones to minimize security risk.