POST/api/v1/domains

Add a domain

Registers a new custom domain in your workspace and returns the TXT record you must add to your DNS to prove ownership. The domain goes through a multi-step verification flow before links can use it.

Authorization

Authorizationstringheaderrequired

Bearer token. Format: Bearer YOUR_API_KEY

Body

domainstringbodyrequired

The domain to add, e.g. go.mycompany.com. Subdomains are supported. Protocol prefix (https://) is stripped automatically.

dnsProviderstringbodyoptional

Your DNS provider. Optional but enables provider-specific setup instructions in the dashboard. Supported values: CLOUDFLARE, ROUTE53, GODADDY, NAMECHEAP, GOOGLE_DOMAINS, HOVER, GANDI, PORKBUN, DNSIMPLE, NS1, NETLIFY, AZURE, CONSTELLIX, DNS_MADE_EASY, VERCEL, EXTERNAL.

curl -X POST https://app.brevr.io/api/v1/domains \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "domain": "go.mycompany.com",
  "dnsProvider": "CLOUDFLARE"
}'

{
"domain": {
  "id": "dom_abc123",
  "domain": "go.mycompany.com",
  "verified": false,
  "verifiedAt": null,
  "createdAt": "2024-06-01T10:00:00.000Z",
  "status": "PENDING_OWNERSHIP",
  "lastCheckedAt": null,
  "failedChecks": 0,
  "activeLinks": 0,
  "ownershipVerified": false,
  "verificationToken": "a1b2c3d4e5f6...",
  "dnsProvider": "CLOUDFLARE"
},
"verification": {
  "type": "TXT",
  "host": "@",
  "value": "brevr-verify=a1b2c3d4e5f6..."
}
}