Skip to content
XStereotype Logo XStereotype Logo XStereotype Docs

Managing API Keys

Viewing API Keys

When you navigate to the API section, you’ll see a table listing all your API keys. Each row contains:

  • API Key ID: Unique identifier for your key
  • API Key: The masked key value
  • Status: Current state (ACTIVE/INACTIVE)
  • Last Used: Timestamp of last usage
  • Risk Profile: Associated profile settings
  • Actions: Edit and delete options
API Keys Table View

Creating a New API Key

Follow these steps to generate a new API key:

  1. Click the “Create New API Key” button in the top right corner API Create Button
  2. Select a Risk Profile from the dropdown (Optional)
  3. Click “Create API Key” to generate
API Create Form

Important

After creation, make sure to:

  • Store it securely
  • Copy the API key value by clicking on the Copy Icon.
Copy API Key

Updating API Key Settings

To modify an existing API key:

  1. Find the target key in the table
  2. Click the edit (pencil) icon in the Actions column Update API Key
  3. Modify the available settings:
    • Risk Profile association
    • Key status Update API Key Form
  4. Save your changes

Deleting an API Key

To remove an API key:

  1. Locate the key in the API keys table
  2. Click the delete (trash) icon Delete API Key
  3. Confirm deletion in the warning dialog
  4. Click “Delete” to permanently remove the key
Delete API Key Warning

Warning

  • Deletion is permanent and cannot be undone
  • All services using this key will stop working immediately
  • Make sure to update any applications using the deleted key

API Key Status

Your API keys can have the following statuses:

StatusDescription
ACTIVEKey is working and can make API calls
INACTIVEKey is temporarily disabled
EXPIREDKey has reached its end date

Best Practices

  1. Regular Rotation

    • Rotate keys periodically for security
    • Create new keys before deleting old ones
    • Update applications with new keys gradually

  2. Access Control

    • Use different keys for different applications
    • Assign appropriate Risk Profiles to each key
    • Monitor “Last Used” timestamps regularly

  3. Security

    • Never share API keys publicly
    • Store keys in secure environment variables
    • Delete unused or compromised keys immediately