Skip to content
Go to Home Page
  • There are no suggestions because the search field is empty.

Managing (Legacy) API Keys in Clearstory

View and delete keys for the current Web API, which is retired after December 15, 2026.

 

 

API keys let you authenticate to the current Clearstory Web API. A new Clearstory API is available, and this version is being retired. It will be turned off after December 15, 2026.

If you are building or updating an integration, use the new API. The steps are in Move to the new Clearstory API.

Access Requirements:

  • Only Account Owners can manage API keys

  • API keys are available only on Professional plans

Accessing the API Keys Page

  1. In the left navigation menu, click Settings.

  2. Under Advanced Settings, select Web API Keys.

Creating an API Key

  1. Click the Generate API Key button.

  2. A pop-up will appear with the message “API Key Created Successfully.”
    This window displays two values:

    • Key ID – The unique identifier for the API key

    • Secret Key – Hidden by default for security

  3. Click the eye icon to reveal your Secret Key.

  4. Click Copy next to each field to copy the Key ID and Secret Key.

⚠️ Important: You must copy your Secret Key immediately.
You will not be able to see it again after closing the pop-up.


🔷 After securely saving your Secret Key, click I’ve copied the secret key to complete the process. Your API key will now appear in your API Keys list.

Managing Your API Keys

Viewing API Keys

The API Keys table displays:

  • Key ID

  • Created (the date the key was generated)

  • Created By

  • Actions (trash icon only)

  • Secret Keys cannot be viewed again and cannot be edited.


Deleting an API Key

  1. Click the trash icon next to the key you want to delete.

  2. Confirm deletion when prompted.

⚠️ Warning:
Deleting an API key immediately invalidates it. This action cannot be undone.

Security Best Practices

  • Treat your Secret Key like a password — do not share it.

  • Store API keys securely (password manager or encrypted environment variables).

  • Delete unused or compromised API keys immediately.

  • Use different API keys for different environments (development, staging, production).

Using Your API Keys

For authentication details, available endpoints, and usage examples, refer to the Clearstory API Documentation.

Need Help?

If you have any questions or issues with API keys, contact our support team:

📧 support@clearstory.build