Previously, our API keys broadly granted access to all account-level and all knowledge bases' resources. All resources could be accessed at the same level based on the actions you selected for the key.
We've had requests from several customers for more fine-grained controls, so we're very excited to announce the release of our new scoped API keys!
Our new scoped API keys give much more control, allowing you to set:
- The knowledge base(s) the API key should be able to access.
- The resources within that knowledge base the API key should have Read, Create, Update, and Delete permissions on.
- Whether the API key should have access to account-level resources like authors and readers and whether those should be Read, Create, Update, and Delete permissions.
These keys give you way more control so you can make sure they only access the knowledge bases and resources you need and handle differing permissions for different resources.
Here's a sample of what the setup screen for one looks like:
Sample Create API key modal for new scoped API keys
Check out the changes
Head to Account > API and select + Add new API key to view the new options.
On the documentation side:
- Head to API keys for updated instructions on creating, editing, and deleting API keys.
- If you're a developer and you want to work backward from the calls you're already making, use our API key permission-endpoint mapping documentation to confirm which model maps to which UI label.
- If you'd like to replace existing keys with new scoped keys, check out the instructions to Upgrade from legacy to scoped API key.
- And we've updated our API endpoint documentation to version 2.0 to include all the permissions you'll need to perform various actions, while making some other improvements, too!
What happens with existing API keys?
We will continue to support our previous legacy API keys for now, but we strongly encourage you to make the switch to the new scoped API keys for better security and more visibility into what the key can and can't access!