Interaktive OpenAPI-Referenz
Diese Seite rendert die vollständige OpenAPI-Spezifikation der CaptainDNS API . Nutzen Sie die linke Seitenleiste, um zwischen den Endpunkten nach Kategorie (DNS, Mail, Web, Text) zu navigieren. Jeder Endpunkt zeigt sein Request-Schema, mögliche Antworten und ein Aufrufbeispiel.
Verwendung dieser Referenz
- Suche: die Scalar-Suchleiste akzeptiert Endpunktnamen, Schemanamen und Tags.
- Schemas: Antworten sind mit den globalen Schemas im Bereich
Componentsverknüpft. - Anfrage testen: für öffentliche Endpunkte können Sie Ihren API-Schlüssel eintragen und direkt aus dem Browser einen Aufruf starten. Vorsicht, dies verbraucht Credits.
- Download: die Schaltfläche
Downloadrechts oben erlaubt den Abruf der Spezifikation als JSON oder YAML.
Erinnerungen vor dem Aufruf
- Authentifizierung: Header
Authorization: Bearer cdns_live_.... Siehe Authentifizierungshandbuch. - Idempotenz: optionaler
Idempotency-Key-Header, siehe Idempotenzhandbuch. - Rate Limiting: beachten Sie
Retry-Afterauf 429-Antworten, siehe Rate Limiting. - Credits: überwachen Sie
X-Credits-Remaining, siehe Credit-Modell.
Versionen und Kompatibilität
Die Spezifikation wird zusammen mit dem Go-Backend versioniert. Breaking Changes werden im Changelog dokumentiert und mindestens 30 Tage vor dem Deployment angekündigt. Nicht brechende Ergänzungen können ohne formelle Ankündigung erfolgen.
Die interaktive Referenz erscheint unten: