domains_v2
GoDaddy Domains v2 API, scoped to a customer: customer_id is resolved from the GODADDY_CUSTOMER_ID environment variable when set, otherwise it is a required parameter (a WHERE value always wins). Accepts a Personal Access Token (Bearer) or a classic sso-key credential.
Overview
| Name | domains_v2 |
| Type | Resource |
| Id | godaddy.domains.domains_v2 |
Fields
The following fields are returned by SELECT queries:
- get
Request was successful
| Name | Datatype | Description |
|---|---|---|
domain_id | string | Unique identifier for this Domain (wire: domainId) |
subaccount_id | string | Reseller subaccount shopperid who can manage the domain (wire: subaccountId) |
actions | array | List of current actions in progress for this domain |
auth_code | string | Authorization code for transferring the Domain (wire: authCode) |
contacts | object | |
created_at | string (iso-datetime) | Date and time when this domain was created (wire: createdAt) |
deleted_at | string (iso-datetime) | Date and time when this domain was deleted (wire: deletedAt) |
dnssec_records | array | List of active DNSSEC records for this domain (wire: dnssecRecords) |
domain | string (domain) | Name of the domain |
expiration_protected | boolean | Whether or not the domain is protected from expiration (wire: expirationProtected) |
expires_at | string (iso-datetime) | Date and time when this domain will expire (wire: expiresAt) |
hold_registrar | boolean | Whether or not the domain is on-hold by the registrar (wire: holdRegistrar) |
hostnames | array | Hostnames owned by the domain |
locked | boolean | Whether or not the domain is locked to prevent transfers |
modified_at | string (iso-datetime) | Date and time when this domain was last modified (wire: modifiedAt) |
name_servers | array | Fully-qualified domain names for DNS servers (wire: nameServers) |
privacy | boolean | Whether or not the domain has privacy protection |
registrar_created_at | string (iso-datetime) | Date and time when this domain was created by the registrar (wire: registrarCreatedAt) |
registry_status_codes | array | The current registry status codes of the domain - ADD_PERIOD — This grace period is provided after the initial registration of a domain name. - AUTO_RENEW_PERIOD — This grace period is provided after a domain name registration period expires and is extended (renewed) automatically by the registry. - CLIENT_DELETE_PROHIBITED — This status code tells your domain's registry to reject requests to delete the domain. - CLIENT_HOLD — This status code tells your domain's registry to not activate your domain in the DNS and as a consequence, it will not resolve. - CLIENT_RENEW_PROHIBITED — This status code tells your domain's registry to reject requests to renew your domain. - CLIENT_TRANSFER_PROHIBITED — This status code tells your domain's registry to reject requests to transfer the domain from your current registrar to another. - CLIENT_UPDATE_PROHIBITED — This status code tells your domain's registry to reject requests to update the domain. - INACTIVE — This status code indicates that delegation information (name servers) has not been associated with your domain. - OK — This is the standard status for a domain, meaning it has no pending operations or prohibitions. - PENDING_CREATE — This status code indicates that a request to create your domain has been received and is being processed. - PENDING_DELETE — This status code indicates that the domain is either in a redemption period if combined with either REDEMPTION_PERIOD or PENDING_RESTORE, if not combined with these, then indicates that the redemption period for the domain has ended and domain will be be purged and dropped from the registry database. - PENDING_RENEW — This status code indicates that a request to renew your domain has been received and is being processed. - PENDING_RESTORE — This status code indicates that your registrar has asked the registry to restore your domain that was in REDEMPTION_PERIOD status - PENDING_TRANSFER — This status code indicates that a request to transfer your domain to a new registrar has been received and is being processed. - PENDING_UPDATE — This status code indicates that a request to update your domain has been received and is being processed. - REDEMPTION_PERIOD — This status code indicates that your registrar has asked the registry to delete your domain. - RENEW_PERIOD — This grace period is provided after a domain name registration period is explicitly extended (renewed) by the registrar. - SERVER_DELETE_PROHIBITED — This status code prevents your domain from being deleted. - SERVER_HOLD — This status code is set by your domain's Registry Operator. Your domain is not activated in the DNS. - SERVER_RENEW_PROHIBITED — This status code indicates your domain's Registry Operator will not allow your registrar to renew your domain. - SERVER_TRANSFER_PROHIBITED — This status code prevents your domain from being transferred from your current registrar to another. - SERVER_UPDATE_PROHIBITED — This status code locks your domain preventing it from being updated. - TRANSFER_PERIOD — This grace period is provided after the successful transfer of a domain name from one registrar to another. (wire: registryStatusCodes) |
renew_auto | boolean | Whether or not the domain is configured to automatically renew (wire: renewAuto) |
renew_deadline | string (iso-datetime) | Date the domain must renew on (wire: renewDeadline) |
renewal | object | |
status | string | The current status of the domain - ACTIVE — Domain has been registered and is active. - CANCELLED — Domain has been cancelled by the user or system, and is not reclaimable. - DELETED_REDEEMABLE — Domain is deleted but is redeemable. - EXPIRED — Domain has expired. - FAILED — Domain registration or transfer error. - LOCKED_REGISTRAR — Domain is locked at the registrar - this is usually the result of a spam, abuse, etc. - PARKED — Domain has been parked. - HELD_REGISTRAR — Domain is held at the registrar and cannot be transferred or modified - this is usually the result of a dispute. - OWNERSHIP_CHANGED — Domain has been moved to another account. - PENDING_TRANSFER — Domain transfer has been requested and is pending the transfer process. - PENDING_REGISTRATION — Domain is pending setup at the registry. - REPOSSESSED — Domain has been confiscated - this is usually the result of a chargeback, fraud, abuse, etc.). - SUSPENDED — Domain is in violation and has been suspended. - TRANSFERRED — Domain has been transferred to another registrar. (ACTIVE, CANCELLED, DELETED_REDEEMABLE, EXPIRED, FAILED, LOCKED_REGISTRAR, PARKED, HELD_REGISTRAR, OWNERSHIP_CHANGED, PENDING_TRANSFER, PENDING_REGISTRATION, REPOSSESSED, SUSPENDED, TRANSFERRED) |
transfer_away_eligible_at | string (iso-datetime) | Date and time when this domain is eligible to transfer (wire: transferAwayEligibleAt) |
transfer_protected | boolean | Whether or not the domain is protected from transfer (wire: transferProtected) |
verifications | object |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | domain, customer_id | x_request_id, includes | Returns the full DomainDetailV2 object including status, contacts, nameservers, lock state, privacy flag, and expiration timestamp. |
update_nameservers | exec | domain, customer_id | x_request_id | Replaces the domain's authoritative nameservers. Returns 202 - poll GET .../actions/DOMAIN_UPDATE_NAME_SERVERS until the action reaches a terminal state. |
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 |
|---|---|---|
customer_id | string (uuid) | GoDaddy customer identifier (UUID, not the numeric shopper number). Resolved from the GODADDY_CUSTOMER_ID environment variable when it is set (server variable, x-stackQL-envVar); otherwise required on every method of this resource. A WHERE value always takes precedence over the environment. API resellers acting on behalf of a subaccount pass the subaccount customer identifier. |
domain | string | Domain whose name servers are to be replaced |
x_request_id | string | A client provided identifier for tracking this request. |
includes | array | Optional details to be included in the response |
x_request_id | string | A client provided identifier for tracking this request. (wire: X-Request-Id) |
SELECT examples
- get
Returns the full DomainDetailV2 object including status, contacts, nameservers, lock state, privacy flag, and expiration timestamp.
SELECT
domain_id,
subaccount_id,
actions,
auth_code,
contacts,
created_at,
deleted_at,
dnssec_records,
domain,
expiration_protected,
expires_at,
hold_registrar,
hostnames,
locked,
modified_at,
name_servers,
privacy,
registrar_created_at,
registry_status_codes,
renew_auto,
renew_deadline,
renewal,
status,
transfer_away_eligible_at,
transfer_protected,
verifications
FROM godaddy.domains.domains_v2
WHERE domain = '{{ domain }}' -- required
AND customer_id = '{{ customer_id }}' -- required unless GODADDY_CUSTOMER_ID is set
AND x_request_id = '{{ x_request_id }}'
AND includes = '{{ includes }}'
;
Lifecycle Methods
EXEC variables use wire (API) names.
- update_nameservers
Replaces the domain's authoritative nameservers. Returns 202 - poll GET .../actions/DOMAIN_UPDATE_NAME_SERVERS until the action reaches a terminal state.
EXEC godaddy.domains.domains_v2.update_nameservers
@customer_id='{{ customer_id }}' --required unless GODADDY_CUSTOMER_ID is set,
@domain='{{ domain }}' --required,
@x_request_id='{{ x_request_id }}',
@name_servers='{{ name_servers }}'
;