Tellagen
← Back to Support Center

Manage workspace API keys

Create a scoped API key, store its one-time token, and revoke it when it is no longer needed.

GuideLast verified Open Markdown version
On this page

Before you start

Intended audience

Workspace managers and operators who configure local or API access.

Required permissions

You need workspace-manager access to API key settings. The API key owner needs an active responder seat for any key with a write scope.

Prerequisites

  • Know the integration purpose and its minimum required scopes.

Procedure

Create the key

  1. Step 1 of 8

    Open API keys

    Open Settings. Select API keys.

  2. Step 2 of 8

    Start a key

    Select Create API key. Enter a purpose-specific name.

  3. Step 3 of 8

    Choose a preset

    Select a preset when it matches the task. Review every included scope.

  4. Step 4 of 8

    Set expiration

    Set the shortest practical expiration before you change individual scopes.

  5. Step 5 of 8

    Limit the scopes

    Keep only the required scopes. Do not grant write access for a read-only integration.

    API key form with preset, expiration, and scope controls.
    Set expiration and review the preset scopes before you create the key. Open full-size image(opens in a new tab)

  6. Step 6 of 8

    Create and store the token

    Select Create key. Store the token immediately because Tellagen shows it once.

Review and revoke

  1. Step 7 of 8

    Find an existing key

    Use the key list filters to find Active, Expired, or Inactive keys.

  2. Step 8 of 8

    Revoke a key

    Open the key's actions. Select Revoke. Confirm the exact key. Tellagen marks it Inactive.

You are done when…

The integration has a minimum-scope token, and the key list shows its current lifecycle state.

Troubleshooting

The key cannot be created.

Enter a Name and select at least one scope. Keep write scopes with an active responder owner.

The one-time token was not stored.

The unseen key remains Active until you revoke it. Find the exact key, revoke it and create a replacement. Store the new token securely. Never copy it into a ticket, timeline event, or public document.

A request returns a scope error.

Use the API Reference to identify the required scope. Create a replacement key with that scope.

Related articles