v2

latestOpenAPI 3.1.0Proprietary2026-07-26127193620.1 KB
Domains

Claim a new domain

Creates an unverified domain claim and returns the exact DNS records to publish in dns_records. Publish those records before calling the verify endpoint. To give users an importable DNS file, call downloadDomainZoneFile or run primitive domains zone-file --id <domain-id>.

post/domains

Headers

Idempotency-Keystring

Optional client-supplied idempotency key. Retrying a request with the same key returns the original result instead of performing the action a second time; if omitted the server derives one from the canonical payload hash. Safe to retry network failures without duplicating side effects.

Request body

domainstring required

The domain name to claim (e.g. "example.com")

confirmedboolean

Set to true to confirm replacing an existing mailbox provider after an mx_conflict response.

outboundboolean

Deprecated and ignored. Outbound DNS is provisioned for every new domain claim.

Response

Domain claim created

successtrue required