Skip to content

Search docs

Find pages, headings, and concepts. Press ⌘K or Ctrl+K to toggle.

Domains

Domain registration, DNS, WHOIS profiles, and lifecycle sync.

Domains covers registrar purchase, DNS records, pricing checks, transfer-in, transfer-out, and importing domains you already own at an external registrar (GoDaddy, Namecheap, or Brandsight).

Domain registration, DNS writes, refresh, verification, settings updates, transfer-in, and transfer-out require an owner/admin browser session with fresh step-up. API keys are rejected with 403 "Domain administration requires a browser session".

Endpoints

MethodPathDescription
GET/api/v1/domainsList domains; lifecycle sync runs in the background (lifecycleSync.status: "background").
POST/api/v1/domainsRegister a domain.
GET/api/v1/domains/checkAvailability check.
GET/api/v1/domains/suggestionsName suggestions.
GET/api/v1/domains/pricesTLD pricing.
GET/api/v1/domains/:idDomain details.
PATCH/api/v1/domains/:idUpdate settings.
GET/api/v1/domains/:id/dnsDNS records.
POST/api/v1/domains/:id/dnsCreate a DNS record; requires browser session + step-up.
PUT/api/v1/domains/:id/dnsUpdate a DNS record (recordId in body); requires browser session + step-up.
DELETE/api/v1/domains/:id/dns?recordId=Delete a DNS record; requires browser session + step-up.
POST/api/v1/domains/transfer-inStart transfer in with a domain authorization code; requires browser session + step-up.
GET/api/v1/domains/:id/transfer-inRefresh and read transfer-in status.
POST/api/v1/domains/:id/refreshRefresh registrar status.
POST/api/v1/domains/:id/verifyVerify ownership.
POST/api/v1/domains/:id/transfer-outStart transfer out.
GET/api/v1/domains/providersList external registrar providers with connector connections and imported domain counts.
POST/api/v1/domains/providers/importImport domains from a connected registrar (provider, optional connectionId, optional domains list of up to 200 names, syncDns defaults to true); requires browser session + step-up.
POST/api/v1/domains/:id/registrar-syncSync DNS records from the external registrar for an imported domain; requires browser session + step-up.

WHOIS contact profiles live under GET/POST/PATCH/DELETE /api/v1/whois-profiles.