Support
API ReferenceDomain Lifecycle

Domains REST reference

View as Markdown

REST reference for the Domains API. v3 quote-execute registration, plus v1/v2 for DNS, contacts, transfers, and forwarding.

Machine-readable specs

The complete OpenAPI specs for this namespace are available as JSON — useful for code generation, SDK tooling, and LLM context: domains-v3.json (discovery + registration), domains-v1.json (account-scoped), and domains-v2.json (async operations).

The Domains REST API exposes domain availability search, registration, DNS and contact management, registry lock, WHOIS privacy, forwarding, and inbound and outbound transfers. Operations span three version namespaces: v3 (quote-execute registration model), v1 (account-scoped), and v2 (async operation tracking).

For a task-shaped guide written for DIY API users, see Use the API → Domains.

The core objects

The Domains namespace is built around a small set of resources. Each operation in the reference reads or writes one of these objects.

ObjectDescription
DomainDetail (v1) / DomainDetailV2 (v2)A registered domain and its registry metadata: name, status, expiration, contacts, nameservers, lock state, and privacy state.
DNSRecordA single DNS record (A, AAAA, CNAME, MX, TXT, SRV, NS, SOA, or CAA) on a domain that uses GoDaddy's authoritative nameservers.
ContactA WHOIS contact record covering name, organization, address, email, and phone. The same shape is used for the registrant, admin, billing, and tech roles on a domain.
ActionAn asynchronous-operation tracker returned with 202 Accepted when the API queues a long-running write. Callers poll the action endpoint until the action's status reaches a terminal state.
DomainAvailableResponseThe result of an availability check, including the available flag, current price in currency-micro-unit format, the registration period in years, and whether the answer is from a live registry call or cache.
DomainForwardingAn HTTP forwarding rule on a domain, configurable as masked or unmasked and as a permanent (301) or temporary (302) redirect.
DomainTransferInThe request shape for an inbound transfer, carrying the domain name, authcode, and required contacts.
Error / ErrorLimitThe standard error envelope returned on 4xx and 5xx responses across the namespace. ErrorLimit extends Error with retryAfterSec for 429 rate-limited responses.

Version namespaces

Conventions used across the namespace

ConcernWhere it's documented
Authentication (PAT for v3; PAT or legacy sso-key for v1/v2)Authentication
Error envelope and retry semanticsErrors
Rate limits (60 requests/minute per credential)Rate limits
Cursor-based pagination on v1 list endpointsPagination

Last updated on

How is this guide?

On this page