How to Create an API Key?

What is an API Key?

Based on your subscription, you may have access to the API feature in your Terminus account.

The Terminus API uses an API key to authenticate requests. You can create and manage your API Keys in your Terminus account.

Your API keys carry many privileges. Keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Please refer to the API Documentation for details about how to use the API.

1. Go to the API Keys page

From the top navigation, click on Account Settings in the dropdown.

Go to the API Keys tab

2. Create a new API Key

a. Click on Add an API Key button

b. Specify the name of the key for your reference.

c. (Optional) Check Has write permission if this key will be used to create data in your Terminus account.

d. Click Save

3. Copy the API Key

Copy the shown API Key. It will only be shown once. It may look something like this:

If you lose your API key, we will not be able to recover it. In that case, create another API key and delete the older one.

You can use your API keys according to the API Documentation.

4. (Optional) Deactivate an API Key

It’s a good security practice to change your API keys regularly. In such cases, you can create a new API key to replace the old one. When your API calls are working with the new key, you can deactivate the old key by following these steps.

a. Edit the API Key

b. Uncheck Active

c. Click Save

If something breaks, you can quickly restore the old key by making it active again. If you no longer need it, it’s best to delete it.