Managing API Keys

Updated 9 months ago ​by Jake Peters

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:

PermissionDescription
ReadAccess GET routes and read data only e.g. displaying articles in your app
WriteAccess POST, PUTPATCH and DELETE routes. Write and update data. e.g. creating articles from your app's backend

Creating a New Key

  1. Log in to your HelpDocs dashboard
  2. Go to Settings > API
  3. Click Create a New API Key
  4. We'll create an API key for you and slide out the sidebar
  5. Enter a name for your key. This is just so you can identify the key later.
  6. Choose permissions for your key by ticking the appropriate checkboxes
  7. Hit Save

The new key will be ready to use right away.

Deleting an Existing Key

  1. Log in to your HelpDocs dashboard
  2. Go to Settings > API
  3. Click the preview icon next to the API key you'd like to remove
  4. Hit Delete

How did we do?