Overview
View as MarkdownReference for the Domains v3 API — a quote-execute model for domain discovery, registration, and management.
Overview
Domains v3 introduces a quote-execute model built for clarity and pricing predictability:
- Discover — check availability and get suggestions
- Quote — lock in a price with a
quoteToken - Register — execute the registration using that token
- Poll — follow the async operation to completion
All write operations return 202 Accepted with an operation or registration ID. Poll the returned URL until status reaches COMPLETED or FAILED.
Endpoint groups
Discovery
Suggest domains for a keyword query and check availability of specific domains. Prices are indicative; locked pricing is only established at quote time.
Registration Quotes
Get a locked price and a quoteToken for one or more domains. The token is required to execute registration and expires after a short window.
Registrations
Execute a registration using a quoteToken and poll for completion. Requires an Idempotency-Key header and a consent record.
Domains
Read registered domain records including status, nameservers, privacy preferences, and expiry date.
Domain Management
Update nameservers for a domain. Returns a DomainOperation to poll for completion.
DNS Records
List, create, replace, and delete DNS records in a GoDaddy-managed zone. Changes apply synchronously.
Operations
Abstract poll endpoint for any async v3 operation. Equivalent to the registration-specific poll URL but usable for any operation type.
Quote-execute flow
GET /v3/domains/check-availability?domain={domain}
→ availability result (indicative price)
POST /v3/domains/registration-quotes
→ quoteToken (locked price, short TTL)
POST /v3/domains/registrations
(body: quoteToken + domain + period + consent)
→ 202 Accepted, Registration entity with poll URL
GET /v3/domains/registrations/{registrationId}
or
GET /v3/domains/operations/{operationId}
→ poll until status = COMPLETED | FAILEDConventions
| Convention | Detail |
|---|---|
| Base URL | https://api.godaddy.com |
| Version prefix | /v3/ |
| Async writes | 202 Accepted with links[rel=self] poll URL |
| Idempotency | Idempotency-Key header required on registration |
| Indicative vs locked | Availability and suggestions return indicative prices; quotes lock the price |
| Auth | Authorization: Bearer ${GODADDY_PAT} |
What v3 does not cover
The following operations are not yet in v3. Use v1 or v2 instead:
| Operation | Use instead |
|---|---|
| Domain renewals | Domains v1 |
| Domain transfers | Domains v1 |
| Contact updates | Domains v1 |
| Domain forwarding | Domains v1 |
| Privacy settings | Domains v1 |
| List owned domains | Domains v1 |
| Shopper-scoped operations | Domains v2 |
Agent & Automation Notes
domains.domain:read, domains.domain:create, domains.dns:update, domains.nameserver:updateRelated
Last updated on
How is this guide?
Domains REST reference
REST reference for the Domains API. v3 quote-execute registration, plus v1/v2 for DNS, contacts, transfers, and forwarding.
Discovery
Indicative, non-committing operations for finding and checking domains. Use suggestDomains for natural-language queries and getDomainAvailability for specific domain verification. Both return indicative pricing; locked pricing is established only at quote time. The check-availability controller carries no persistent identity.