domains

Creates, updates, deletes, gets or lists a domains resource.

Overview

Name	domains
Type	Resource
Id	godaddy.domains.domains

Fields

The following fields are returned by SELECT queries:

get

Request was successful

Name	Datatype	Description
authCode	string	Authorization code for transferring the Domain
contactAdmin	object	Administrative contact for the domain registration
contactBilling	object	Billing contact for the domain registration
contactRegistrant	object	Registration contact for the domain
contactTech	object	Technical contact for the domain registration
createdAt	string (date-time)	Date and time when this domain was created
deletedAt	string (date-time)	Date and time when this domain was deleted
domain	string	Name of the domain
domainId	number (double)	Unique identifier for this Domain
expirationProtected	boolean	Whether or not the domain is protected from expiration
expires	string (date-time)	Date and time when this domain will expire
holdRegistrar	boolean	Whether or not the domain is on-hold by the registrar
locked	boolean	Whether or not the domain is locked to prevent transfers
nameServers	array	Fully-qualified domain names for DNS servers
privacy	boolean	Whether or not the domain has privacy protection
renewAuto	boolean	Whether or not the domain is configured to automatically renew
renewDeadline	string (date-time)	Date the domain must renew on
status	string	Processing status of the domain ACTIVE - All is well AWAITING* - System is waiting for the end-user to complete an action CANCELLED* - Domain has been cancelled, and may or may not be reclaimable CONFISCATED - Domain has been confiscated, usually for abuse, chargeback, or fraud DISABLED* - Domain has been disabled EXCLUDED* - Domain has been excluded from Firehose registration EXPIRED* - Domain has expired FAILED* - Domain has failed a required action, and the system is no longer retrying HELD* - Domain has been placed on hold, and likely requires intervention from Support LOCKED* - Domain has been locked, and likely requires intervention from Support PARKED* - Domain has been parked, and likely requires intervention from Support PENDING* - Domain is working its way through an automated workflow RESERVED* - Domain is reserved, and likely requires intervention from Support REVERTED - Domain has been reverted, and likely requires intervention from Support SUSPENDED* - Domain has been suspended, and likely requires intervention from Support TRANSFERRED* - Domain has been transferred out UNKNOWN - Domain is in an unknown state UNLOCKED* - Domain has been unlocked, and likely requires intervention from Support UNPARKED* - Domain has been unparked, and likely requires intervention from Support UPDATED* - Domain ownership has been transferred to another account
subaccountId	string	Reseller subaccount shopperid who can manage the domain
transferProtected	boolean	Whether or not the domain is protected from transfer
verifications	object	Progress and status for each of the verification processes requested for this domain

list

Request was successful

Name	Datatype	Description
authCode	string	Authorization code for transferring the Domain
contactAdmin	object	Administrative contact for the domain registration
contactBilling	object	Billing contact for the domain registration
contactRegistrant	object	Registration contact for the domain
contactTech	object	Technical contact for the domain registration
createdAt	string (date-time)	Date and time when this domain was created
deletedAt	string (date-time)	Date and time when this domain was deleted
domain	string	Name of the domain
domainId	number (double)	Unique identifier for this Domain
expirationProtected	boolean	Whether or not the domain is protected from expiration
expires	string (date-time)	Date and time when this domain will expire
holdRegistrar	boolean	Whether or not the domain is on-hold by the registrar
locked	boolean	Whether or not the domain is locked to prevent transfers
nameServers	array	Fully-qualified domain names for DNS servers
privacy	boolean	Whether or not the domain has privacy protection
renewAuto	boolean	Whether or not the domain is configured to automatically renew
renewDeadline	string (date-time)	Date the domain must renew on
renewable	boolean	Whether or not the domain is eligble for renewal based on status
status	string	Processing status of the domain ACTIVE - All is well AWAITING* - System is waiting for the end-user to complete an action CANCELLED* - Domain has been cancelled, and may or may not be reclaimable CONFISCATED - Domain has been confiscated, usually for abuse, chargeback, or fraud DISABLED* - Domain has been disabled EXCLUDED* - Domain has been excluded from Firehose registration EXPIRED* - Domain has expired FAILED* - Domain has failed a required action, and the system is no longer retrying HELD* - Domain has been placed on hold, and likely requires intervention from Support LOCKED* - Domain has been locked, and likely requires intervention from Support PARKED* - Domain has been parked, and likely requires intervention from Support PENDING* - Domain is working its way through an automated workflow RESERVED* - Domain is reserved, and likely requires intervention from Support REVERTED - Domain has been reverted, and likely requires intervention from Support SUSPENDED* - Domain has been suspended, and likely requires intervention from Support TRANSFERRED* - Domain has been transferred out UNKNOWN - Domain is in an unknown state UNLOCKED* - Domain has been unlocked, and likely requires intervention from Support UNPARKED* - Domain has been unparked, and likely requires intervention from Support UPDATED* - Domain ownership has been transferred to another account
transferProtected	boolean	Whether or not the domain is protected from transfer

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain	X-Shopper-Id	Retrieve details for the specified Domain
list	select		X-Shopper-Id, statuses, statusGroups, limit, marker, includes, modifiedDate	Retrieve a list of Domains for the specified Shopper
contacts_validate	exec	domains	X-Private-Label-Id, marketId	All contacts specified in request will be validated against all domains specifed in "domains". As an alternative, you can also pass in tlds, with the exception of uk, which requires full domain names
purchase	exec	domain, consent	X-Shopper-Id	Purchase and register the specified Domain
validate	exec	domain, consent		Validate the request body using the Domain Purchase Schema for the specified TLD
cancel	exec	domain		Cancel a purchased domain
update	exec	domain	X-Shopper-Id	Update details for the specified Domain
update_contacts	exec	domain, contactRegistrant	X-Shopper-Id	Update domain
cancel_privacy	exec	domain	X-Shopper-Id	Submit a privacy cancellation request for the given domain
purchase_privacy	exec	domain, consent	X-Shopper-Id	Purchase privacy for a specified domain
renew	exec	domain	X-Shopper-Id	Renew the specified Domain
transfer_in	exec	domain, authCode, consent	X-Shopper-Id	Purchase and start or restart transfer process
verify_email	exec	domain	X-Shopper-Id	Re-send Contact E-mail Verification for specified Domain

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain	string	Domain whose Contact E-mail should be verified.
X-Private-Label-Id	integer	PrivateLabelId to operate as, if different from JWT
X-Shopper-Id	string	Shopper for whom domain contact e-mail should be verified. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com
includes	array	Optional details to be included in the response
limit	integer	Maximum number of domains to return
marker	string	Marker Domain to use as the offset in results
marketId	string (bcp-47)	MarketId in which the request is being made, and for which responses should be localized
modifiedDate	string (iso-datetime)	Only include results that have been modified since the specified date
statusGroups	array	Only include results with status value in any of the specified groups
statuses	array	Only include results with status value in the specified set

SELECT examples

get

Retrieve details for the specified Domain

SELECT
authCode,
contactAdmin,
contactBilling,
contactRegistrant,
contactTech,
createdAt,
deletedAt,
domain,
domainId,
expirationProtected,
expires,
holdRegistrar,
locked,
nameServers,
privacy,
renewAuto,
renewDeadline,
status,
subaccountId,
transferProtected,
verifications
FROM godaddy.domains.domains
WHERE domain = '{{ domain }}' -- required
AND X-Shopper-Id = '{{ X-Shopper-Id }}'
;

list

Retrieve a list of Domains for the specified Shopper

SELECT
authCode,
contactAdmin,
contactBilling,
contactRegistrant,
contactTech,
createdAt,
deletedAt,
domain,
domainId,
expirationProtected,
expires,
holdRegistrar,
locked,
nameServers,
privacy,
renewAuto,
renewDeadline,
renewable,
status,
transferProtected
FROM godaddy.domains.domains
WHERE X-Shopper-Id = '{{ X-Shopper-Id }}'
AND statuses = '{{ statuses }}'
AND statusGroups = '{{ statusGroups }}'
AND limit = '{{ limit }}'
AND marker = '{{ marker }}'
AND includes = '{{ includes }}'
AND modifiedDate = '{{ modifiedDate }}'
;

Lifecycle Methods

contacts_validate

All contacts specified in request will be validated against all domains specifed in "domains". As an alternative, you can also pass in tlds, with the exception of uk, which requires full domain names

EXEC godaddy.domains.domains.contacts_validate 
@X-Private-Label-Id='{{ X-Private-Label-Id }}', 
@marketId='{{ marketId }}' 
@@json=
'{
"contactAdmin": "{{ contactAdmin }}", 
"contactBilling": "{{ contactBilling }}", 
"contactPresence": "{{ contactPresence }}", 
"contactRegistrant": "{{ contactRegistrant }}", 
"contactTech": "{{ contactTech }}", 
"domains": "{{ domains }}", 
"entityType": "{{ entityType }}"
}'
;

purchase

Purchase and register the specified Domain

EXEC godaddy.domains.domains.purchase 
@X-Shopper-Id='{{ X-Shopper-Id }}' 
@@json=
'{
"consent": "{{ consent }}", 
"contactAdmin": "{{ contactAdmin }}", 
"contactBilling": "{{ contactBilling }}", 
"contactRegistrant": "{{ contactRegistrant }}", 
"contactTech": "{{ contactTech }}", 
"domain": "{{ domain }}", 
"nameServers": "{{ nameServers }}", 
"period": {{ period }}, 
"privacy": {{ privacy }}, 
"renewAuto": {{ renewAuto }}
}'
;

validate

Validate the request body using the Domain Purchase Schema for the specified TLD

EXEC godaddy.domains.domains.validate 
@@json=
'{
"consent": "{{ consent }}", 
"contactAdmin": "{{ contactAdmin }}", 
"contactBilling": "{{ contactBilling }}", 
"contactRegistrant": "{{ contactRegistrant }}", 
"contactTech": "{{ contactTech }}", 
"domain": "{{ domain }}", 
"nameServers": "{{ nameServers }}", 
"period": {{ period }}, 
"privacy": {{ privacy }}, 
"renewAuto": {{ renewAuto }}
}'
;

cancel

Cancel a purchased domain

EXEC godaddy.domains.domains.cancel 
@domain='{{ domain }}' --required
;

update

Update details for the specified Domain

EXEC godaddy.domains.domains.update 
@domain='{{ domain }}' --required, 
@X-Shopper-Id='{{ X-Shopper-Id }}' 
@@json=
'{
"locked": {{ locked }}, 
"nameServers": "{{ nameServers }}", 
"renewAuto": {{ renewAuto }}, 
"subaccountId": "{{ subaccountId }}"
}'
;

update_contacts

Update domain

EXEC godaddy.domains.domains.update_contacts 
@domain='{{ domain }}' --required, 
@X-Shopper-Id='{{ X-Shopper-Id }}' 
@@json=
'{
"contactAdmin": "{{ contactAdmin }}", 
"contactBilling": "{{ contactBilling }}", 
"contactRegistrant": "{{ contactRegistrant }}", 
"contactTech": "{{ contactTech }}"
}'
;

cancel_privacy

Submit a privacy cancellation request for the given domain

EXEC godaddy.domains.domains.cancel_privacy 
@domain='{{ domain }}' --required, 
@X-Shopper-Id='{{ X-Shopper-Id }}'
;

purchase_privacy

Purchase privacy for a specified domain

EXEC godaddy.domains.domains.purchase_privacy 
@domain='{{ domain }}' --required, 
@X-Shopper-Id='{{ X-Shopper-Id }}' 
@@json=
'{
"consent": "{{ consent }}"
}'
;

renew

Renew the specified Domain

EXEC godaddy.domains.domains.renew 
@domain='{{ domain }}' --required, 
@X-Shopper-Id='{{ X-Shopper-Id }}' 
@@json=
'{
"period": {{ period }}
}'
;

transfer_in

Purchase and start or restart transfer process

EXEC godaddy.domains.domains.transfer_in 
@domain='{{ domain }}' --required, 
@X-Shopper-Id='{{ X-Shopper-Id }}' 
@@json=
'{
"authCode": "{{ authCode }}", 
"consent": "{{ consent }}", 
"period": {{ period }}, 
"privacy": {{ privacy }}, 
"renewAuto": {{ renewAuto }}
}'
;

verify_email

Re-send Contact E-mail Verification for specified Domain

EXEC godaddy.domains.domains.verify_email 
@domain='{{ domain }}' --required, 
@X-Shopper-Id='{{ X-Shopper-Id }}'
;