Référence OpenAPI interactive

Cette page rend la spécification OpenAPI complète de l'API publique CaptainDNS. Utilisez le sommaire à gauche pour naviguer entre les endpoints par catégorie (DNS, Mail, Web, Text). Chaque endpoint affiche son schéma de requête, ses réponses possibles et un exemple d'appel.

Comment utiliser cette référence

• Recherche : la barre de recherche accepte des noms d'endpoints, de schémas et de tags.
• Schémas : les réponses sont reliées aux schémas globaux, consultables dans la section Components.
• Essayez la requête : vous pouvez saisir votre clé API et exécuter un appel directement depuis le navigateur. Attention, cela consomme des crédits comme n'importe quel appel.
• Téléchargement : bouton Download en haut à droite pour récupérer la spécification brute au format JSON ou YAML.

Rappels avant d'appeler

• Authentification : header Authorization: Bearer cdns_live_.... Voir le guide d'authentification.
• Idempotence : header Idempotency-Key optionnel, voir le guide idempotence.
• Rate limiting : respectez Retry-After sur les 429, voir le rate limiting.
• Crédits : vérifiez X-Credits-Remaining dans la réponse, voir le modèle de crédits.

Versions et compatibilite

La spécification est versionnée en même temps que l'API. Les changements de rupture sont consignés dans le changelog et annoncés au minimum 30 jours avant leur déploiement. Les ajouts non breaking (nouveaux endpoints, nouveaux champs optionnels) peuvent arriver sans préavis formel.

La référence interactive apparaît ci-dessous :