reseller

is added when reseller has a customer specific business

Renew

Description

Renews an existing Enterprise Email Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The Order Id which is to be renewed.
months Integer Required The number of months for which the Order is to be renewed.
no-of-accounts Integer Optional Additional Email Accounts to be purchased for the Enterprise Email Order, if required.
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order.

Note

Auto-Renewal
invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd

HTTP Method

POST

Example Test URL Request

US Server


https://test.httpapi.com/api/enterpriseemail/us/renew.json?auth-userid=0&api-key=key&order-id=0&months=0&invoice-option=NoInvoice

India Server


https://test.httpapi.com/api/enterpriseemail/in/renew.json?auth-userid=0&api-key=key&order-id=0&months=0&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order Id of the Enterprise Email Order (entityid)

  • Action Type (actiontype)

  • Description of the Enterprise Email Order Renewal Action (actiontypedesc)

  • Action Id of the Enterprise Email Order Renewal Action (eaqid)

  • Enterprise Email Order Renewal Action Status (actionstatus)

  • Description of the Enterprise Email Order Renewal Action Status (actionstatusdesc)

  • Invoice Id of the Enterprise Email Order Renewal Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Curreny Amount (sellingamount)

  • Customer Id associated with the Enterprise Email Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Add

Description

Places an Enterprise Email Order for the specified domain name.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name String Required The domain name for which the Order is placed.
customer-id Integer Required The Customer under whom the Order should be added.
months Integer Required The number of months for which the Order is placed.
no-of-accounts Integer Required The number of email accounts required.
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order.

Note

Auto-Renewal
invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd

HTTP Method

POST

Example Test URL Request

US Server


https://test.httpapi.com/api/enterpriseemail/us/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&no-of-accounts=15&invoice-option=NoInvoice

India Server


https://test.httpapi.com/api/enterpriseemail/in/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&no-of-accounts=15&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order Id of the Domain Registration Order (entityid)

  • Action Type (actiontype)

  • Description of the Domain Registration Action (actiontypedesc)

  • Action Id of the Domain Registration Action (eaqid)

  • Domain Registration Action Status (actionstatus)

  • Description of the Domain Registration Action Status (actionstatusdesc)

  • Invoice Id of the Domain Registration Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Price for Customers (sellingamount)

  • Customer Id associated with the Domain Registration Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Getting Details of the Domain Registration Order using Domain Name

Description

Gets details of the Domain Registration Order associated with the specified domain name.

Parameters

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.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/domains/details-by-name.json?auth-userid=0&api-key=key&domain-name=yourdomain.com&options=OrderDetails

Response

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
Note

  • 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.

Getting the List of States for a Specific Country

Description

Gets the list of States for a specified Country.

Parameters

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

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/country/state-list.xml?auth-userid=0&api-key=key&country-code=nn

Response

Returns the list of States for the Specified Country with the below details:

  • State ID

  • State Name

Getting Currency Details

Description

Gets details of the supported Currencies.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/currency/details.xml?auth-userid=0&api-key=key

Response

Returns details of the supported Currencies as below:

  • Currency Symbol

  • Currency Name (currencyname)

  • Currency Unit (currencyunit)

Get DNS Records

Description

Gets the DNS records of a Single Domain Windows Hosting Order.

Parameters

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

HTTP Method

GET

Example Test URL Request

US, Texas Server


https://test.httpapi.com/api/singledomainhosting/windows/us/dns-record.json?auth-userid=0&api-key=key&order-id=0

US, California Server


https://test.httpapi.com/api/singledomainhosting/windows/us/ca/dns-record.json?auth-userid=0&api-key=key&order-id=0

UK Server


https://test.httpapi.com/api/singledomainhosting/windows/uk/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

Hong Kong Server


https://test.httpapi.com/api/singledomainhosting/windows/hk/dns-record.json?auth-userid=0&api-key=key&order-id=0

Turkey Server


https://test.httpapi.com/api/singledomainhosting/windows/tr/dns-record.json?auth-userid=0&api-key=key&order-id=0

Response

Returns DNS records of the domain name.

Change Hosting Panel Password

Description

Changes the hosting panel password of the specified Single Domain Windows Hosting Order.

Parameters

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.

HTTP Method

POST

Example Test URL Request

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

US, California Server


https://test.httpapi.com/api/singledomainhosting/windows/us/ca/change-password.json?auth-userid=0&api-key=key&order-id=0&new-passwd=password1

UK Server


https://test.httpapi.com/api/singledomainhosting/windows/uk/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

Hong Kong Server


https://test.httpapi.com/api/singledomainhosting/windows/hk/change-password.json?auth-userid=0&api-key=key&order-id=0&new-passwd=password1

Turkey Server


https://test.httpapi.com/api/singledomainhosting/windows/tr/change-password.json?auth-userid=0&api-key=key&order-id=0&new-passwd=password1

Response

Returns status as success if the password is changed successfully.

Subscribe to reseller