Skip to content

Settings — API Tokens

Settings — API Tokens

API tokens are used to authenticate requests to the Notifiq API.

Creating a token

  1. Go to Settings → API Tokens
  2. Click New Token
  3. Enter a name (e.g. checkmk-prod, android-panel)
  4. Choose an expiry (or leave blank for no expiry)
  5. Select scopes
  6. Copy the token — it will only be shown once

Scopes

Tokens can be restricted to specific operations:

ScopeAllows
NotifyPOST /api/notify — send notifications
PanelPanel registration, SSE connection, heartbeat
MetricsGET /tenant-metrics — Prometheus scraping

A token with all three scopes has full API access. A token with only Notify cannot connect as a panel or read metrics.

Token security

  • Tokens are hashed with bcrypt before storage — not recoverable after creation
  • Revoke tokens immediately if compromised
  • Use short-lived tokens for temporary integrations
  • Create one token per integration for easy revocation

Revoking a token

Click the Revoke button next to any token. Revoked tokens stop working immediately.