Domains
Endpoints for managing domains.
List domains
List all domains for the authenticated team.
query Parameters
expand[]Expand related resources.
querySearch query.
statusFilter by domain status.
sortSort by up to five fields, separated by commas. Prefix a field with - for descending order.
pageper_pageSearch metadata key-value pairs. Only exact matches are supported.
List domains › Responses
Paginated set of Domain
List specific domains
Retrieve up to 100 domains by name or ID. Results preserve the requested order,
but domains that do not exist or are not accessible to the authenticated team
are omitted. Use expand[]=notices to include each domain's current notices.
List specific domains › Request Body
domainsList of domain names or IDs to retrieve.
expandExpand related resources.
List specific domains › Responses
Array of Domain
Show domain
Show a single domain for the authenticated team.
path Parameters
domainNameOrIdfull domain name or ID
query Parameters
expand[]Expand related resources.
Show domain › Responses
DomainWithNotices
Delete a domain
Request immediate deletion for a single domain for the authenticated team.
This action may not always be possible to be reversed and may involve extra costs.
path Parameters
domainNameOrIdfull domain name or ID
Delete a domain › Responses
DomainWithNotices
Update a domain
Update properties of a single domain for the authenticated team.
Only the properties that are provided will be updated. If you omit a property it will not be changed.
path Parameters
domainNameOrIdfull domain name or ID
query Parameters
expand[]Expand related resources.
Update a domain › Request Body
is_lockedLock or unlock the domain. If the domain is locked, it cannot be transferred to another registrar. Note that not all domains support locking. If the domain does not support locking, the request will be rejected. Check the is_lockable property on the domain to see if it supports locking.
is_using_hosted_dnsEnable hosted DNS, or disable it to revert to the default nameservers. When disabling hosted DNS you may also provide custom nameservers.
is_autorenew_enabledEnabled or disables auto-renewal for the domain.
is_dnssec_enabledCan be used to disable DNSSEC for the domain. If you want to enable DNSSEC use dnssec_keys and provide at least one key.
is_whois_privacy_enabledEnable or disable WHOIS privacy for the domain. This is not supported by all TLDs, check supports_whois_privacy first before setting this attribute. If you disable WHOIS privacy the team's default contacts will be used for all handle types. Alternatively, you can provide contacts to set custom contacts for the domain which will also disable WHOIS privacy.
Cannot be provided together with contacts.
Map of contacts for the domain. Only the provided contact types will be updated, any omitted contact types will remain unchanged. When you provide contact handles that are not supported by the TLD they will be ignored.
If you want to reset all contacts to the team's default provide an empty object.
If WHOIS privacy is enabled for the domain it will be disabled.
Cannot be provided together with is_whois_privacy_enabled.
Enable or disable DNSSEC for the domain. This is not supported by all TLDs, check supports_dnssec first before setting this attribute. If you enable DNSSEC you need to provide at least one DNSSEC key. To disable DNSSEC provide an empty array.
Cannot be provided together with is_dnssec_enabled.
Custom nameservers to use when hosted DNS is disabled. You need to provide at least two nameservers.
Optional metadata to attach to the domain. Metadata keys must be strings and cannot exceed 40 characters or contain [ or ] characters. Keys starting with domainchief: are read-only system metadata: they may be returned in responses, but are ignored in write requests and do not count towards the 50 key limit.
Metadata values must be strings and cannot exceed 500 characters.
A domain cannot have more than 50 metadata keys.
To remove a metadata key, set its value to an empty string.
To remove all metadata, set the metadata field to an empty object: {}.
Update a domain › Responses
DomainWithNotices