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.
1. API-Key anlegen
Abschnitt betitelt „1. API-Key anlegen“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.
2. Erster Aufruf
Abschnitt betitelt „2. Erster Aufruf“Alle Aufrufe gehen an https://api.regfish.com und tragen den Key im Header x-api-key:
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.
3. Die Antwort lesen
Abschnitt betitelt „3. Die Antwort lesen“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.
4. Etwas ändern
Abschnitt betitelt „4. Etwas ändern“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.
Wie es weitergeht
Abschnitt betitelt „Wie es weitergeht“| Ziel | Weg |
|---|---|
| Zertifikate ohne Handarbeit verlängern | certbro oder die TLS-Rezepte |
| Ein Server hält seine IP selbst aktuell | DynDNS |
| Records aus Skripten pflegen | DNS-Sollzustand |
| Einen KI-Assistenten anbinden | MCP-Server |
| Eine Domain durchleuchten | DNS Doctor |
Wenn etwas hakt
Abschnitt betitelt „Wenn etwas hakt“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.