API-Keys¶
REST-API-Tokens für externe Integrationen — CI/CD, SIEM, Monitoring-Tools, Custom-Apps.
Tabelle¶
Pro API-Key:
- Name / Beschreibung
- Key-Prefix — die ersten 20 Zeichen des Keys (
nmg_xxxxxxxxxx) — voll-Key wird nicht mehr angezeigt - Scope —
read-only/quarantine-only/domain-admin/full-admin - Rate-Limit — Requests pro Minute (Default 100)
- Last-Used — Zeitstempel der letzten API-Verwendung
- Expires-At — optional Ablaufdatum
Aktionen¶
- Plus — neuen Key generieren. Form-Felder: Name, Scope, Rate-Limit, optional Ablaufdatum. Beim Save wird der vollständige Key einmalig angezeigt mit Copy-Button. Danach in der DB nur noch Hash + Prefix.
- Edit — Name, Scope, Rate-Limit anpassen. Key selbst kann nicht editiert werden.
- Revoke — Key wird sofort ungültig. Bestehende Requests mit diesem Key bekommen 401.
- Delete — Key komplett aus der DB entfernen.
Sicherheit¶
- Keys haben Format
nmg_<64hex>(insgesamt 68 Zeichen) - Bei Verlust: kein Recovery, neuen Key erstellen + alten revoken
- Rate-Limit per Token-Bucket — Bursts bis 10× sustained-rate, danach 429 Too Many Requests
Verwendung¶
curl -H 'X-API-Key: nmg_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
https://mailguard.example.com:3443/api/v1/quarantine