Domain tools
List, inspect, and update settings on domains the org owns.
Read-only tools require domains:read. update_domain_settings requires domains:write. The EPP auth_code only ships in responses to keys with domains:write.
list_org_domains
Cursor-paginated listing of an org’s domains.
Required scope: domains:read.
org_oid string path required state string path Filter by state:
registered, expired, redemption, external, deleted, failed, pending. cursor string path Domain name from a previous page’s
next_cursor. limit integer path default: 50 Max 100.
domains object[] Domain summaries (see
get_domain for shape). next_cursor string | null total_count integer Total matching, ignoring cursor.
get_domain
Full record for one domain, including subscription and (for domains:write keys) the EPP auth_code.
Required scope: domains:read.
domain string path required org_oid string path required name string tld string state string registered, expired, redemption, etc. registration_status string dns_management string domaingenius or external. ns_management string for_sale boolean sale_min_offer_aud number redirect_url string auto_renew boolean privacy boolean expiry string ISO 8601 timestamp.
cloudflare_zone_id string contacts_synced_at string dns_setup boolean worker_setup boolean nameserver_setup boolean nameserver_one string nameserver_two string auth_code string EPP transfer code. Returned only with
domains:write scope. subscription object Period, price, auto-renew status.
update_domain_settings
Update the safe per-domain knobs.
Required scope: domains:write.
domain string path required org_oid string path required auto_renew boolean path privacy boolean path Toggle WHOIS privacy. Some TLDs (e.g.
.com.au) ignore privacy at the registry. for_sale boolean path List or unlist on the marketplace.
sale_min_offer integer path Minimum offer in cents.
redirect_url string path Absolute http(s) URL. Empty string clears the redirect.
DNS, nameserver, and contact-role changes are out of scope here — see the DNS, contact, and (API-only) registrar-sync tools.
Last updated
Edit this page