Referencia OpenAPI interactiva
Esta página renderiza la especificacion OpenAPI completa de la API de CaptainDNS a traves del lector interactivo Scalar. Usa el índice de la izquierda para navegar entre los endpoints por categoría (DNS, Mail, Web, Text). Cada endpoint muestra su esquema de peticion, las respuestas posibles y un ejemplo de llamada.
Como usar esta referencia
- Busqueda: la barra de Scalar acepta nombres de endpoints, esquemas y tags.
- Esquemas: las respuestas se enlazan con los esquemas globales en la sección
Components. - Prueba la peticion: para los endpoints publicos, puedes pegar tu clave API y ejecutar una llamada desde el navegador. Atencion, consume créditos.
- Descarga: el boton
Downloadpermite obtener la especificacion en JSON o YAML.
Recordatorios antes de llamar
- Autenticación: cabecera
Authorization: Bearer cdns_live_.... Ver la guia de autenticación. - Idempotencia: cabecera
Idempotency-Keyopcional, ver la guia de idempotencia. - Rate limiting: respeta
Retry-Afteren los 429, ver rate limiting. - Créditos: vigila
X-Credits-Remaining, ver el modelo de créditos.
Versiones y compatibilidad
La especificacion se versiona al mismo tiempo que la API. Los cambios de ruptura se anuncian en el changelog con al menos 30 dias de antelacion. Las adiciones no destructivas pueden llegar sin aviso formal.
La referencia interactiva aparece a continuacion: