API Reference
Authoritative endpoint-by-endpoint documentation. Each page covers one resource family with request/response shapes, query parameters, and error codes.
For task-oriented walkthroughs, see Tutorials. For the mental model, see Concepts.
Authentication and identity#
- Authentication —
/api/v1/auth/*, OAuth token exchange, JWT validation. - API Keys —
/api/v1/api-keys/*, creating and rotating machine credentials. - Users, Groups, and Roles —
/api/v1/admin/users/*,/admin/groups/*,/roles/*.
Zones and records#
- Domains —
/api/v1/domains/*, the core zone surface. - Records —
/api/v1/domains/{id}/records/*. - Reverse Zones —
/api/v1/reverse-zones/*, CIDR-based zone creation and PTR records. - Templates —
/api/v1/templates/*. - DNSSEC —
/api/v1/domains/{id}/dnssec/*. - Domain Validation —
/api/v1/domains/{id}/validation/*.
Platform#
- Administration —
/api/v1/admin/*, platform admin endpoints. - Audit Log —
/api/v1/admin/audit-logs/*. - Webhooks —
/api/v1/webhooks/scaikey, inbound from ScaiKey.
Errors#
- Error Codes — exhaustive list of error shapes and HTTP status codes.