Managing API Keys

Create, view, and delete API keys for external integrations with TPTM.

Overview

API keys allow your organization to securely connect external tools and integrations to TPTM. Each key is unique to your organization and can be used to authenticate API requests.

ℹ️ Permission required: You must have the Key: Manage permission to access the API Keys page. If you don't see the API Keys option in the Admin menu, contact your organization administrator.

How to Access the API Keys Page

  1. Open the Admin section from the sidebar navigation.

  2. Click API Keys.

You'll see a table listing all existing API keys for your organization.

Understanding the API Keys Table

The table displays all API keys in your organization with the following columns:

Column

Description

Example

Name

The descriptive name you gave the key when you created it.

Production Integration

API Key

A masked version of the key for identification. The full key is never shown again after creation.

tptm_550e84…0000

Created

The date the key was generated.

Mar 1, 2026

Actions

A trash icon to permanently delete the key.

🗑️

How to Create an API Key

  1. Click the Create API Key button at the top of the page.

  2. Enter a descriptive name for the key (for example, "Production Integration" or "Staging Environment").

  3. Click Create.

  4. Your new API key will be displayed in the modal. Click the copy button next to the key to copy it to your clipboard.

  5. Click Done to close the modal.

⚠️ Important: Your API key is only shown once at the time of creation. After you close the modal, the full key cannot be retrieved again. Make sure to copy and store it in a secure location before closing.

How to Delete an API Key

  1. Find the key you want to remove in the API Keys table.

  2. Click the trash icon in the Actions column for that key.

  3. A confirmation dialog will appear showing the name of the key you are about to delete.

  4. Click Delete to permanently remove the key.

⚠️ Warning: Deleting an API key is permanent and cannot be undone. Any integrations using that key will immediately stop working.

Best Practices

  • Use descriptive names — Name each key after the integration or environment it's used for so you can easily identify it later.

  • Store keys securely — Save your API key in a password manager or secrets vault immediately after creation.

  • Rotate keys regularly — If you suspect a key has been compromised, delete it and create a new one right away.

  • Limit access — Only share API keys with team members who need them for their integrations.

  • One key per integration — Create separate keys for each integration so you can revoke access individually without disrupting other systems.

See Also

  • Roles & Permissions — Learn how to set up roles with the Key: Manage permission so team members can manage API keys.

  • Members — View your organization's members and assign roles.

Frequently Asked Questions