Managing API Keys
You can create and delete API keys in your account's API settings.
Only account owners can manage and view API keys
Every API key has a set of permissions that control what actions the key can perform. Possible permissions are:
Permission | Description |
Read | Access GET routes and read data only e.g. displaying articles in your app |
Write | Access POST, PUT, PATCH and DELETE routes. Write and update data. e.g. creating articles from your app's backend |
Permission Groups | Apply Permission Groups so only certain members can use API Keys |
Creating a New Key
- Log in to your HelpDocs dashboard
- Go to Settings > API
- Click Create a New API Key
- We'll create an API key for you and slide out the sidebar
- Enter a name for your key. This is just so you can identify the key later.
- Choose permissions for your key by ticking the appropriate checkboxes
- Hit Save
The new key will be ready to use right away.
Deleting an Existing Key
- Log in to your HelpDocs dashboard
- Go to Settings > API
- Click the preview icon next to the API key you'd like to remove
- Hit Delete
