Referencia OpenAPI interactiva
Esta página renderiza la especificación OpenAPI completa de la API de CaptainDNS a través 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 petición, las respuestas posibles y un ejemplo de llamada.
Cómo usar esta referencia
- Búsqueda: 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 petición: para los endpoints públicos, puedes pegar tu clave API y ejecutar una llamada desde el navegador. Atención, consume créditos.
- Descarga: el botón
Downloadpermite obtener la especificación en JSON o YAML.
Recordatorios antes de llamar
- Autenticación: cabecera
Authorization: Bearer cdns_live_.... Ver la guía de autenticación. - Idempotencia: cabecera
Idempotency-Keyopcional, ver la guía 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 especificación se versiona al mismo tiempo que la API. Los cambios de ruptura se anuncian en el changelog con al menos 30 días de antelación. Las adiciones no destructivas pueden llegar sin aviso formal.
La referencia interactiva aparece a continuación: