⌘K
Dashboard

Create, scope, rotate, and revoke the API keys used by the current proxy routes.

API Keys

API keys authenticate requests to Souma's validation routes. In the current dashboard they live at Integration > API Keys.

Generating a key

  1. Navigate to your dashboard
  2. Go to Integration > API Keys
  3. Click Generate new key
  4. Name the key by environment or service
  5. Copy and securely store the raw key

Important: API keys are shown only once at creation. Store them securely before closing the dialog.

Key permissions

ScopeDescription
provenance:readRead provenance-related records
provenance:writeWrite provenance-related records
validation:readRead validation results
validation:writeSubmit RtU checks

Usage monitoring

The current UI focuses on operational management rather than deep key analytics. Use the dashboard to confirm status, created time, and scope assignment, then monitor request behavior from your service logs or proxy metrics.

Rotation pattern

  1. create a replacement key
  2. update the downstream service or environment secret
  3. confirm new traffic is healthy
  4. revoke the old key

When teams usually need a new key

  • a new deployment environment
  • a new internal service
  • a suspected exposure
  • a scope change between read-only and write access

Revoking a key

If a key is compromised:

  1. Go to Integration > API Keys
  2. Find the compromised key
  3. Click Revoke
  4. Generate a new key and update your applications