RESELLERS: Read this to Setup your Enterprise Email
Please wait while you are redirected ....
![]() |
is added when reseller has a customer specific business
Please wait while you are redirected ....
Gets details of the Domain Registration Order associated with the specified domain name.
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| domain-name | String | Required | Domain name associated with the Domain Registration Order whose details need to be fetched. |
| options | Array of Strings | Required | Values can be: All, OrderDetails, ContactIds, RegistrantContactDetails, AdminContactDetails, TechContactDetails, BillingContactDetails, NsDetails, DomainStatus, DNSSECDetails. |
GET
https://test.httpapi.com/api/domains/details-by-name.json?auth-userid=0&api-key=key&domain-name=yourdomain.com&options=OrderDetails
Returns a hash map containing details of the Domain Registration Order as below:
Order ID (orderid)
Order Description (description)
Domain Name (domainname)
Current Order Status under the System (currentstatus) - value will be InActive, Active, Suspended, Pending Delete Restorable, Deleted or Archived
Lock/Hold on the domain name at the Registry (orderstatus) - value(s) will be resellersuspend, resellerlock and/or transferlock
Lock/Hold on the domain name in the System (domainstatus) - value(s) will be sixtydaylock and/or renewhold
Product Category (productcategory)
Product Key (productkey)
Order Creation (at the Registry) Date (creationtime)
Registrant Contact Email Address Verification Status (raaVerificationStatus) - value will be Verified, Pending or Suspended
Start Time of the Registrant Contact Email Address Verification Process (raaVerificationStartTime) - will not be displayed if the Verification Status is Verified
Expiry Date (at the Registry) (endtime)
Whether Order belongs to a Customer directly under the Reseller (isImmediateReseller)
Reseller Chain by RID (parentkey)
Customer ID Associated with the Order (customerid)
Number of Name Servers associated with the Domain Name (noOfNameServers)
Name Servers (ns1 and ns2)
Child Name Servers (cns)
Domain Secret (domsecret)
Whether Order Suspended due to Expiry (isOrderSuspendedUponExpiry)
Whether Order Suspended by Parent Reseller (orderSuspendedByParent)
Whether Privacy Protection allowed for the Product Type (privacyprotectedallowed)
Whether Order is Privacy Protected (isprivacyprotected)
Privay Protection Details:
Privacy Protection Expiry Date (privacyprotectendtime)
Privacy Protect Registrant Contact Details (privacy-registrantcontact)
Privacy Protect Admin Contact Details (privacy-admincontact)
Privacy Protect Technical Contact Details (privacy-techcontact)
Privacy Protect Billing Contact Details (privacy-billingcontact)
Whether Order Deletion is Allowed (allowdeletion)
Registrant Contact ID (registrantcontactid)
Registrant Contact Details (registrantcontact)
Admin Contact ID (admincontactid)
Admin Contact Details (admincontact)
Technical Contact ID (techcontactid)
Technical Contact Details (techcontact)
Billing Contact ID (billingcontactid)
Billing Contact Details (billingcontact)
Delegation Signer (DS) Record Details (dnssec):
Key Tag (keytag)
Algorithm (algorithm)
Digest Type (digesttype)
Digest (digest)
Details differ based on the value passed for the options parameter:
| Options | Details Returned |
|---|---|
| All | All values listed above |
| OrderDetails | domainname, entityid, orderstatus, creationtime, endtime, productcategory, productkey, isImmediateReseller, parentkey, customerid, domsecret, isOrderSuspendedUponExpiry, orderSuspendedByParent, privacyprotectedallowed, isprivacyprotected, privacyprotectendtime, privacy-registrantcontact, privacy-admincontact, privacy-techcontact, privacy-billingcontact and allowdeletion |
| ContactIds | isImmediateReseller, isOrderSuspendedUponExpiry, privacyprotectedallowed, isprivacyprotected, privacyprotectendtime, privacy-registrantcontact, privacy-admincontact, privacy-techcontact, privacy-billingcontact, registrantcontactid, admincontactid, techcontactid and billingcontactid |
| RegistrantContactDetails / AdminContactDetails / TechContactDetails / BillingContactDetails | isImmediateReseller, isOrderSuspendedUponExpiry, privacyprotectedallowed, isprivacyprotected, privacyprotectendtime, privacy-registrantcontact / privacy-admincontact / privacy-techcontact / privacy-billingcontact and registrantcontactid / admincontactid / techcontactid / billingcontactid |
| NsDetails | noOfNameServers, ns1, ns2, isImmediateReseller, isOrderSuspendedUponExpiry, privacyprotectedallowed, isprivacyprotected, privacyprotectendtime, privacy-registrantcontact, privacy-admincontact, privacy-techcontact and privacy-billingcontact |
| DomainStatus | domainstatus, raaVerificationStatus, raaVerificationStartTime, isImmediateReseller, isOrderSuspendedUponExpiry, privacyprotectedallowed, isprivacyprotected, privacyprotectendtime, privacy-registrantcontact, privacy-admincontact, privacy-techcontact and privacy-billingcontact |
| DNSSECDetails | dnssec, isImmediateReseller, isOrderSuspendedUponExpiry, privacyprotectedallowed, isprivacyprotected, privacyprotectendtime, privacy-registrantcontact, privacy-admincontact, privacy-techcontact and privacy-billingcontact |
privacyprotectedallowed will be returned only if Privacy Protection feature is supported for the Product Type (TLD).
privacyprotectendtime, privacy-registrantcontact, privacy-admincontact, privacy-techcontact and privacy-billingcontact will be returned only if Privacy Protection is enabled for the domain name.
Gets the list of States for a specified Country.
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| country-code | String | Required | Country Code as per ISO 3166-1 alpha-2 |
GET
https://test.httpapi.com/api/country/state-list.xml?auth-userid=0&api-key=key&country-code=nn
Returns the list of States for the Specified Country with the below details:
State ID
State Name
Gets the list of Countries.
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
GET
https://test.httpapi.com/api/country/list.xml?auth-userid=0&api-key=key
Returns the list of Countries with the below details:
Country Code
Country Name
Gets details of the supported Currencies.
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
GET
https://test.httpapi.com/api/currency/details.xml?auth-userid=0&api-key=key
Returns details of the supported Currencies as below:
Currency Symbol
Currency Name (currencyname)
Currency Unit (currencyunit)
Gets the DNS records of a Single Domain Windows Hosting Order.
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Required | Order Id of the Single Domain Windows Hosting Order |
GET
US, Texas Server
https://test.httpapi.com/api/singledomainhosting/windows/us/dns-record.json?auth-userid=0&api-key=key&order-id=0
India Server
https://test.httpapi.com/api/singledomainhosting/windows/in/dns-record.json?auth-userid=0&api-key=key&order-id=0
Returns DNS records of the domain name.
Changes the hosting panel password of the specified Single Domain Windows Hosting Order.
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Required | Order ID of the Single Domain Windows Hosting Order whose hosting panel password needs to be changed. |
| new-passwd | String | Required | New password. |
POST
US, Texas Server
https://test.httpapi.com/api/singledomainhosting/windows/us/change-password.json?auth-userid=0&api-key=key&order-id=0&new-passwd=password1
India Server
https://test.httpapi.com/api/singledomainhosting/windows/in/change-password.json?auth-userid=0&api-key=key&order-id=0&new-passwd=password1
Returns status as success if the password is changed successfully.
Use this method to get details of the pricing for the Single Domain Windows Hosting plans for your Sub-Resellers.
Returns a map with the prices of the Single Domain Windows Hosting plans along with the prices of the other products.
The response structure for the Single Domain Windows Hosting will be:
"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}
Example:
US, Texas Server
"singledomainhostingwindowsus":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
India Server
"singledomainhostingwindowsin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
Use this method to get details of the pricing for the Single Domain Windows Hosting plans.
Returns a map with the prices of the Single Domain Windows Hosting plans along with the prices of the other products.
The response structure for the Single Domain Windows Hosting will be:
"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}
Example:
US, Texas Server
"singledomainhostingwindowsus":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}
India Server
"singledomainhostingwindowsin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}