Skip to main content

Overview

API keys provide programmatic access for integrations and automation. Cysmiq supports personal keys and workspace keys.

Key types

Key typeWhere you manage itScopeNotes
Personal API keyUser security settingsUser scopedCan be restricted to specific workspaces
Workspace API keyWorkspace security settingsTenant scopedManaged by workspace admins

Scopes

Available scopes in the UI:
  • Read vulnerabilities (vulnerabilities:read): Access vulnerability lists and summary data for repositories

Expiration options

The field is labeled Expires in the UI.
  • 7 days
  • 30 days
  • 90 days
  • 180 days
  • 365 days
  • Never

Key lifecycle

  • Create: Name the key, choose scopes, and select an expiration
  • One time display: New keys are shown once. Copy and store them securely
  • Status: Keys are marked Active, Expired, or Disabled
  • Usage details: View created time, last used time, expiration date, and scopes
  • Revoke: Revoke a key to permanently disable it