Referência OpenAPI interativa

Esta página renderiza a especificação OpenAPI completa da API pública CaptainDNS. Use o índice à esquerda para navegar entre os endpoints por categoria (DNS, Mail, Web, Text). Cada endpoint mostra seu esquema de requisição, respostas possíveis e um exemplo de chamada.

Como usar esta referência

• Busca: a barra de busca do Scalar aceita nomes de endpoints, esquemas e tags.
• Esquemas: as respostas são ligadas aos esquemas globais, consultáveis na seção Components.
• Teste a requisição: para os endpoints públicos, você pode colar sua chave API e executar uma chamada diretamente do navegador. Atenção, consome créditos.
• Download: o botão Download no canto superior direito permite baixar a especificação como JSON ou YAML.

Lembretes antes de chamar

• Autenticação: header Authorization: Bearer cdns_live_.... Veja o guia de autenticação.
• Idempotência: header Idempotency-Key opcional, veja o guia de idempotência.
• Rate limiting: respeite Retry-After nos 429, veja rate limiting.
• Créditos: monitore X-Credits-Remaining, veja o modelo de créditos.

Versões e compatibilidade

A especificação é versionada junto com a API. Os breaking changes são listados no changelog e anunciados com pelo menos 30 dias de antecedência. Adições não destrutivas podem ser feitas sem aviso formal.

A referência interativa aparece abaixo: