API-Key erstellen

Jeder Aufruf der regfish-API braucht einen API-Key im Header x-api-key. Angelegt wird er im dash.

Wo der Schlüssel liegt

Konto → Sicherheit → API Keys, direkte Adresse: dash.regfish.de/my/setting/security/api-keys

Die Tabelle führt je Schlüssel:

Spalte	Bedeutung
Erzeugt am	Zeitpunkt der Erstellung
Status	Aktiv oder deaktiviert
API-Key (letzten 4 Stellen)	nur das Ende des Schlüssels — der vollständige Wert wird nie wieder angezeigt
Berechtigungen	welche Bereiche der Schlüssel nutzen darf, änderbar über Verwalten
Zuletzt verwendet	woran sich ungenutzte Schlüssel erkennen lassen

Über Weiteren API-Key hinzufügen legst du einen neuen an, über deaktivieren schaltest du einen vorübergehend ab, über löschen entfernst du ihn endgültig.

Der Schlüssel wird genau einmal angezeigt

Beim Anlegen bekommst du den vollständigen Schlüssel ein einziges Mal zu sehen. Danach zeigt das dash nur noch die letzten vier Stellen. Kopiere ihn also sofort dorthin, wo er hingehört — in einen Passwortmanager, in die CI-Konfiguration oder in eine .env-Datei außerhalb des Repos.

Achtung

Ein API-Key ist ein Kennwort. Er gehört nicht in ein Git-Repository, nicht in eine Chat-Nachricht und nicht in eine URL. Verdacht auf einen abgeflossenen Schlüssel? Im dash löschen und einen neuen anlegen — das ist billiger als jede Untersuchung.

Rechte einschränken

Über Verwalten legst du fest, was ein Schlüssel darf. Ein Schlüssel mit Voller Produktzugriff kann alles, was du selbst kannst. Für ein Skript, das nur DNS-Records liest, ist das mehr als nötig — schränke ihn auf den kleinsten Umfang ein, der die Aufgabe erfüllt.

Welche Rechte ein Aufruf braucht, steht bei jedem Endpunkt in der API-Referenz. Fehlt ein Recht, antwortet die API mit 401 und nennt in der Fehlermeldung den Weg dorthin.

Welche Rechte ein bestehender Schlüssel tatsächlich hat, verrät auch die API selbst: Aktuellen API-Key einsehen.

Verwendung

curl -X GET 'https://api.regfish.com/dns/zones' \
  -H 'x-api-key: $REGFISH_API_KEY'

Der Schlüssel gehört in eine Umgebungsvariable, nicht in den Befehl selbst — sonst steht er in der Shell-History.

Nächste Schritte

• Erste Schritte — der erste Aufruf gegen die API
• DNS-Einträge bearbeiten — dieselbe Aufgabe in der Oberfläche
• Rezepte — fertige Abläufe für wiederkehrende Aufgaben