Zum Inhalt springen

Erste Schritte mit der API

Es gibt zwei Wege zu regfish: klicken im dash oder automatisieren über die API. Diese Seite ist der Einstieg in den zweiten Weg und braucht etwa fünf Minuten.

Der Key entsteht im dash, der Weg dorthin steht in API-Key erstellen. Gib ihm nur die Rechte, die der Einsatzzweck braucht: Ein Key, der nur dns:read darf, kann auch dann keine Records ändern, wenn er in falsche Hände gerät.

Alle Aufrufe gehen an https://api.regfish.com und tragen den Key im Header x-api-key:

Terminal-Fenster
curl 'https://api.regfish.com/dns/zones' \
-H "x-api-key: $REGFISH_API_KEY"

Das listet die DNS-Zonen des Kontos, also deine Domains. Die Referenz dazu: DNS-Zonen auflisten.

Jede Antwort trägt denselben Envelope:

{
"success": true,
"code": 200,
"response": {"zones": ["example.com"]}
}

success sagt, ob der Aufruf gelungen ist, code folgt HTTP, die Nutzlast steht unter response. Fehlt dem Key ein Recht, weist die API den Aufruf ab und nennt das fehlende Recht. Die Begriffe dahinter, Zone gegen Record, die rrid, der Punkt am Ende von Namen, stehen in den Grundbegriffen; jede Feldstruktur steht in den Schemas.

Der erste schreibende Aufruf ist meist DNS-Record anlegen. Auf jeder Endpunktseite baut ein Request-Builder aus deinen Werten den fertigen Befehl zum Kopieren. Vor Änderungen an produktiven Zonen lohnt das Rezept DNS-Änderung mit Rollback: Es sichert den alten Zustand, bevor es schreibt.

ZielWeg
Zertifikate ohne Handarbeit verlängerncertbro oder die TLS-Rezepte
Ein Server hält seine IP selbst aktuellDynDNS
Records aus Skripten pflegenDNS-Sollzustand
Einen KI-Assistenten anbindenMCP-Server
Eine Domain durchleuchtenDNS Doctor

Die Suche oben findet jede Seite dieser Doku. Und die API beantwortet Fragen selbst: Den regfish-Assistenten fragen nimmt eine Frage in Alltagssprache entgegen und antwortet mit Verweisen in Konto und Doku.