Interactive OpenAPI reference

This page renders the complete OpenAPI specification of the CaptainDNS public API. Use the left sidebar to navigate between endpoints by category (DNS, Mail, Web, Text). Each endpoint shows its request schema, possible responses and a sample call.

How to use this reference

• Search: the Scalar search bar accepts endpoint names, schema names and tags.
• Schemas: responses link to the shared schemas, available in the Components section.
• Try it: for public endpoints, you can paste your API key and fire a request directly from the browser. Beware, this consumes credits like any other call.
• Download: the Download button in the top right lets you grab the raw specification as JSON or YAML.

Reminders before you call

• Authentication: header Authorization: Bearer cdns_live_.... See the authentication guide.
• Idempotency: optional Idempotency-Key header, see the idempotency guide.
• Rate limiting: respect Retry-After on 429 responses, see rate limiting.
• Credits: monitor X-Credits-Remaining in each response, see the credit model.

Versions and compatibility

The specification is versioned alongside the API. Breaking changes are listed in the changelog and announced at least 30 days before their deployment. Non-breaking additions (new endpoints, new optional fields) can ship without formal notice.

The interactive reference appears below: