Domains

Custom domains let you brand your short links with your own domain (e.g. go.mycompany.com). Each domain goes through a DNS verification flow before links can be created on it.

POST /api/v1/domains — Add a new custom domain to your workspace.

Add Domain

GET /api/v1/domains — Retrieve all domains in your workspace with their verification status.

List Domains

GET /api/v1/domains/:id — Fetch a single domain by ID.

Get Domain

DELETE /api/v1/domains/:id — Remove a domain from your workspace.

Delete Domain

The Domain Object


{
  "id": "dom_abc123",
  "domain": "go.mycompany.com",
  "verified": true,
  "verifiedAt": "2024-06-02T12:00:00.000Z",
  "createdAt": "2024-06-01T10:00:00.000Z",
  "status": "ACTIVE",
  "lastCheckedAt": "2024-06-15T08:00:00.000Z",
  "failedChecks": 0,
  "activeLinks": 127,
  "ownershipVerified": true,
  "verificationToken": null,
  "dnsProvider": "CLOUDFLARE"
}

Fields

Field	Type	Description
`id`	string	Unique identifier for the domain
`domain`	string	The domain name, e.g. `go.mycompany.com`
`verified`	boolean	Whether DNS routing is confirmed active
`verifiedAt`	string \| null	ISO 8601 timestamp when DNS was verified
`createdAt`	string	ISO 8601 timestamp
`status`	string	See Domain Status below
`lastCheckedAt`	string \| null	ISO 8601 timestamp of the last health check
`failedChecks`	number	Consecutive failed DNS health checks
`activeLinks`	number	Number of active links using this domain
`ownershipVerified`	boolean	Whether the TXT ownership record was confirmed
`verificationToken`	string \| null	Token for the TXT record — present until ownership is verified
`dnsProvider`	string \| null	The DNS provider, e.g. `CLOUDFLARE`, `ROUTE53`

Domain Status

Status	Description
`PENDING_OWNERSHIP`	Waiting for the TXT ownership record to be added
`PENDING_CLOUDFLARE`	Ownership verified; registering with Brevr’s edge network
`PENDING_DNS`	Edge registered; waiting for CNAME/ALIAS to point to Brevr
`ACTIVE`	Fully verified and routing traffic
`DEGRADED`	Previously active but DNS health checks are failing