v1

latestSwagger 2.02026-07-136573327.3 KB

Domains

Retrieve details for the specified Domain

get/v2/customers/{customerId}/domains/{domain}

Path parameters

customerIdstring required

The Customer identifier Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id.

domainstring required

Domain name whose details are to be retrieved

Query parameters

includesstring[]

Optional details to be included in the response

Headers

X-Request-Idstring

A client provided identifier for tracking this request.

Response

Request was successful

domainIdstring required

Unique identifier for this Domain

domainstring domain required

Name of the domain

subaccountIdstring

Reseller subaccount shopperid who can manage the domain

The current status of the domain <ul><li>ACTIVE - Domain has been registered and is active.</li><li>CANCELLED - Domain has been cancelled by the user or system, and is not be reclaimable.</li><li>DELETED_REDEEMABLE - Domain is deleted but is redeemable.</li><li>EXPIRED - Domain has expired.</li><li>FAILED - Domain registration or transfer error.</li><li>LOCKED_REGISTRAR - Domain is locked at the registrar - this is usually the result of a spam, abuse, etc.</li><li>PARKED - Domain has been parked.</li><li>HELD_REGISTRAR - Domain is held at the registrar and cannot be transferred or modified - this is usually the result of a dispute.</li><li>OWNERSHIP_CHANGED - Domain has been moved to another account.</li><li>PENDING_TRANSFER - Domain transfer has been requested and is pending the transfer process.</li><li>PENDING_REGISTRATION - Domain is pending setup at the registry.</li><li>REPOSSESSED - Domain has been confiscated - this is usually the result of a chargeback, fraud, abuse, etc.).</li><li>SUSPENDED - Domain is in violation and has been suspended.</li><li>TRANSFERRED - Domain has been transferred to another registrar.</li></ul>

expiresAtstring iso-datetime

Date and time when this domain will expire

expirationProtectedboolean required

Whether or not the domain is protected from expiration

holdRegistrarboolean required

Whether or not the domain is on-hold by the registrar

lockedboolean required

Whether or not the domain is locked to prevent transfers

privacyboolean required

Whether or not the domain has privacy protection

registrarCreatedAtstring iso-datetime

Date and time when this domain was created by the registrar

renewAutoboolean required

Whether or not the domain is configured to automatically renew

renewDeadlinestring iso-datetime required

Date the domain must renew on

transferProtectedboolean required

Whether or not the domain is protected from transfer

createdAtstring iso-datetime required

Date and time when this domain was created

deletedAtstring iso-datetime

Date and time when this domain was deleted

modifiedAtstring iso-datetime

Date and time when this domain was last modified

transferAwayEligibleAtstring iso-datetime

Date and time when this domain is eligible to transfer

authCodestring required

Authorization code for transferring the Domain

nameServersstring[] required

Fully-qualified domain names for DNS servers

hostnamesstring[]

Hostnames owned by the domain

registryStatusCodesstring[]

The current registry status codes of the domain <ul><li>ADD_PERIOD - This grace period is provided after the initial registration of a domain name.</li><li>AUTO_RENEW_PERIOD - This grace period is provided after a domain name registration period expires and is extended (renewed) automatically by the registry.</li><li>CLIENT_DELETE_PROHIBITED - This status code tells your domain's registry to reject requests to delete the domain.</li><li>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.</li><li>CLIENT_RENEW_PROHIBITED - This status code tells your domain's registry to reject requests to renew your domain.</li><li>CLIENT_TRANSFER_PROHIBITED - This status code tells your domain's registry to reject requests to transfer the domain from your current registrar to another.</li><li>CLIENT_UPDATE_PROHIBITED - This status code tells your domain's registry to reject requests to update the domain.</li><li>INACTIVE - This status code indicates that delegation information (name servers) has not been associated with your domain.</li><li>OK - This is the standard status for a domain, meaning it has no pending operations or prohibitions.</li><li>PENDING_CREATE - This status code indicates that a request to create your domain has been received and is being processed.</li><li>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.</li><li>PENDING_RENEW - This status code indicates that a request to renew your domain has been received and is being processed.</li><li>PENDING_RESTORE - This status code indicates that your registrar has asked the registry to restore your domain that was in REDEMPTION_PERIOD status</li><li>PENDING_TRANSFER - This status code indicates that a request to transfer your domain to a new registrar has been received and is being processed.</li><li>PENDING_UPDATE - This status code indicates that a request to update your domain has been received and is being processed.</li><li>REDEMPTION_PERIOD - This status code indicates that your registrar has asked the registry to delete your domain.</li><li>RENEW_PERIOD - This grace period is provided after a domain name registration period is explicitly extended (renewed) by the registrar.</li><li>SERVER_DELETE_PROHIBITED - This status code prevents your domain from being deleted. </li><li>SERVER_HOLD - This status code is set by your domain's Registry Operator. Your domain is not activated in the DNS.</li><li>SERVER_RENEW_PROHIBITED - This status code indicates your domain's Registry Operator will not allow your registrar to renew your domain.</li><li>SERVER_TRANSFER_PROHIBITED - This status code prevents your domain from being transferred from your current registrar to another. </li><li>SERVER_UPDATE_PROHIBITED - This status code locks your domain preventing it from being updated.</li><li>TRANSFER_PERIOD - This grace period is provided after the successful transfer of a domain name from one registrar to another. </li></ul>