API Access
Managing API keys
Learn how to see your API keys, revoke one and keep your keys safe
You manage your keys on the API Keys page of the Covram Dashboard. To open it, sign in, then open Settings in the sidebar and choose API Keys.
See your keys
The page lists every key you have created:
| Column | What it shows |
|---|---|
| Label | The label you gave the key, or API key if you left it blank. |
| Key | The start of the key, so you can tell your keys apart. The rest is not shown. |
| Created | When you generated it. |
| Last Used | When something last used it. It is empty if the key has never been used. |
| Status | Active or Revoked. |
You can have more than one key. Using a separate key, with its own label, for each tool or person makes it easy to see which one is in use, and to stop one without affecting the others.
Revoke a key
Revoke a key when you no longer need it, or if it may have been seen by someone it shouldn't have been.
- Open the
API Keyspage. - Find the key and click
Revoke.
A revoked key stops working straight away and can't be turned back on. If you still need access, generate a new key and update the tool that used the old one.
Keep your keys safe
- Treat a key like a password. Anyone who has it can read the data of your projects.
- Don't share it or publish it. Keep it out of emails, shared documents and public code.
- Revoke it if you're unsure. It costs nothing to generate a new one.
If API access is removed
If Covram turns off API access for your account, your keys stop working.