---
title: API Reference
path: reference
status: published
---

# 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](../tutorials/index.md). For the mental model, see [Concepts](../concepts/index.md).

## Authentication and identity

- [Authentication](./authentication.md) — `/api/v1/auth/*`, OAuth token exchange, JWT validation.
- [API Keys](./api-keys.md) — `/api/v1/api-keys/*`, creating and rotating machine credentials.
- [Users, Groups, and Roles](./users-and-access.md) — `/api/v1/admin/users/*`, `/admin/groups/*`, `/roles/*`.

## Zones and records

- [Domains](./domains.md) — `/api/v1/domains/*`, the core zone surface.
- [Records](./records.md) — `/api/v1/domains/{id}/records/*`.
- [Reverse Zones](./reverse-zones.md) — `/api/v1/reverse-zones/*`, CIDR-based zone creation and PTR records.
- [Templates](./templates.md) — `/api/v1/templates/*`.
- [DNSSEC](./dnssec.md) — `/api/v1/domains/{id}/dnssec/*`.
- [Domain Validation](./validation.md) — `/api/v1/domains/{id}/validation/*`.

## Platform

- [Administration](./admin.md) — `/api/v1/admin/*`, platform admin endpoints.
- [Audit Log](./audit-log.md) — `/api/v1/admin/audit-logs/*`.
- [Webhooks](./webhooks.md) — `/api/v1/webhooks/scaikey`, inbound from ScaiKey.

## Errors

- [Error Codes](./error-codes.md) — exhaustive list of error shapes and HTTP status codes.