Managing Your API Keys: Create, Edit, and Delete

This guide explains how to create, edit, and delete API keys in your Terminus.app account. API keys allow you to authenticate requests and integrate Terminus.app with other applications.

Accessing the API Keys Page

All API keys are managed from a single page in your account settings.

1. Log in to your Terminus.app account.
2. Click on your Profile Email in the top-right corner and select Account Settings.

3. From the settings menu, click the API Keys tab.

1. How to Create an API Key

1. On the API Keys page, click the Add an API Key button.

2. In the Name field, enter a descriptive name for your key so you can easily identify its purpose (e.g., "Internal Analytics Script").
3. (Optional) Check the Has write permission box if this key will be used to create or modify data. For read-only access, leave this box unchecked.
4. Click Save.

1.1. Copy Your New API Key

After saving, your new API key will be displayed. It may look something like this:

• Important: For your security, the full API key is shown only once.
• Immediately copy the key and store it in a secure location, such as a password manager. If you navigate away from this screen or lose the key, it cannot be recovered. You will need to delete the key and create a new one.

2. How to Edit or Deactivate an API Key

You can edit a key's name or temporarily deactivate it without permanently deleting it.

1. Find the key you wish to modify in the list on the API Keys page.
2. Click the Edit (pencil) icon next to it.

3. To deactivate the key, uncheck the Active box. To reactivate it, check the box.
4. Click Save.

3. How to Delete an API Key

Deleting an API key is permanent and will immediately revoke its access. This action cannot be undone.

1. Find the key you wish to delete from the list.
2. Click the Delete (trash can) icon next to it.

3. A confirmation window will appear. Click Delete api key to permanently remove the key.

Best Practices

• Principle of Least Privilege: Create separate keys for different applications. Only grant write permission if it is absolutely necessary for the integration.
• Key Rotation: For enhanced security, get into the practice of regularly deleting old keys and creating new ones, especially for critical integrations.
• Deactivate Before Deleting: When rotating keys, first create the new key and update your application. Then, deactivate the old key to ensure everything works as expected before permanently deleting it.

You can now securely manage the full lifecycle of your API keys. For detailed information on available endpoints and how to use your keys, please refer to our official API documentation.