reseller

is added when reseller has a customer specific business

Adding Child Name Servers

Description

Adds Child Name Servers for the specified Domain Registration 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 Domain Registration Order for which you want to add the Child Name Servers.
cns String Required Child Name Servers name that you want to add.
ip Array of Strings Required IP addresses that you want to associate with the Child Name Servers.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/add-cns.json?auth-userid=0&api-key=key&order-id=0&cns=ns1.domain.com&ip=0.0.0.0&ip=1.1.1.1

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 Child Name Server Addition Action (actiontypedesc)

  • Action ID of the Child Name Server Addition Action (eaqid)

  • Child Name Server Addition Action Status (actionstatus)

  • Description of the Child Name Server Addition Action Status (actionstatusdesc)

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

Modifying the Auth-Code

Description

Modifies the Auth-Code of the specified Domain Registration 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 Domain Registration Order whose auth-code you want to modify.
auth-code String Required New auth-code.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/modify-auth-code.json?auth-userid=0&api-key=key&order-id=0&auth-code=authcode

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 Auth-Code Modification Action (actiontypedesc)

  • Action ID of the Auth-Code Modification Action (eaqid)

  • Auth-Code Modification Action Status (actionstatus)

  • Description of the Auth-Code Modification Action Status (actionstatusdesc)

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

Modifying the Privacy Protection Status

Description

Changes the Privacy Protection status of the specified Domain Registration 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 Domain Registration Order whose privacy protection you want to change.
protect-privacy Boolean Required Enable / Disable Privacy Protection service. Possible values are: true or false.
reason String Required The reason to enable / disable Privacy Protection.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/modify-privacy-protection.json?auth-userid=0&api-key=key&order-id=0&protect-privacy=true&reason=somereason

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 Privacy Protection Modification Action (actiontypedesc)

  • Action ID of the Privacy Protection Modification Action (eaqid)

  • Privacy Protection Modification Action Status (actionstatus)

  • Description of the Privacy Protection Modification Action Status (actionstatusdesc)

  • Invoice ID of the Privacy Protection Purchase Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilized Transaction Amount in the Selling Currency (unutilisedsellingamount)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will be returned even if the Selling Price for Privacy Protection is set to zero, since a zero priced Invoice will be raised while enabling Privacy protection.

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

Modifying Contacts

Description

Modifies the Contacts of the specified Domain Registration 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 Domain Registration Order whose contact association you want to modify.
reg-contact-id Integer Required The Contact that you want to use as the new Registrant Contact.
admin-contact-id Integer Required The Contact that you want to use as the new Admin Contact.
tech-contact-id Integer Required The Contact that you want to use as the new Technical Contact.
billing-contact-id Integer Required The Contact that you want to use as the new Billing Contact.
sixty-day-lock-optout Boolean Optional Pass this parameter if you want to opt-out of 60 day lock placed after Registrant Contact change is completed

Note

  • Applicable only for GTLDs and if Registrar is opted-in for IRTP
  • Authorized User: Reseller
designated-agent Boolean Optional Pass this parameter as TRUE if you want to opt for Designated Agent. By default this parameter is set to FALSE

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/modify-contact.json?auth-userid=0&api-key=key&order-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0

Example Test URL Request for Opt-Out of 60 day lock that is applied post Registrant Change


https://test.httpapi.com/api/domains/modify-contact.json?auth-userid=0&api-key=key&order-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&sixty-day-lock-optout=true

Example Test URL Request for Applying Designated Agent


https://test.httpapi.com/api/domains/modify-contact.json?auth-userid=0&api-key=key&order-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&designated-agent=true

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 Contact Modification Action (actiontypedesc)

  • Action ID of the Contact Modification Action (eaqid)

  • Contact Modification Action Status (actionstatus)

  • Description of the Contact Modification Action Status (actionstatusdesc)

  • IRTP Status (irtp_status)

  • Status of Losing FOA (losing-foa-status)

  • Gaining Contact Info (gaining-contact-info)

    • Organization (organization)

    • Name (name)

    • Contact ID (id)

    • Email (email)

  • Status of Gaining FOA (gaining-foa-status)

  • FOA Expiry (expiry)

  • Message (message)

  • Status of Sixty Day Lock (sixty-day-lock-status)

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

Modifying Name Servers

Description

Modifies the Name Servers of the specified Domain Registration 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 Domain Registration Order whose Name Servers you want to modify.
ns Array of Strings Required New Name Servers.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/modify-ns.json?auth-userid=0&api-key=key&order-id=0&ns=ns1.domain.asia&ns=ns2.domain.asia

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 Name Server Modification Action (actiontypedesc)

  • Action ID of the Name Server Modification Action (eaqid)

  • Name Server Modification Action Status (actionstatus)

  • Description of the Name Server Modification Action Status (actionstatusdesc)

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

Resending the Transfer Approval Mail

Description

Resends the Transfer Approval Mail for the specified 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 for which the RFA mail needs to be resent.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/resend-rfa.json?auth-userid=0&api-key=key&order-id=0

Response

Returns true (String) if mail is sent successfully.

Modifying TEL Whois Preference

Description

Modifies the Whois Preference of the .TEL Domain Registration 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 Domain Registration Order for which you need to modify the Whois Preference.
whois-type String Required It can be either Natural or Legal
publish String Optional Whether Whois details are to be published or not: Y/N.

This parameter is required if whois-type parameter is Natural, otherwise is it Optional.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/tel/modify-whois-pref.json?auth-userid=0&api-key=key&order-id=0&whois-type=Legal&publish=y

Response

Returns a hash map containing the Whois modification request status details:

  • Domain Name (description)

  • Order ID of the Domain Registration Order (entityid)

  • Action Type (actiontype)

  • Description of the Whois Preference Modification Action (actiontypedesc)

  • Action ID of the Whois Preference Modification Action (eaqid)

  • Whois Preference Modification Action Status (actionstatus)

  • Description of the Whois Preference Modification Action Status (actionstatusdesc)

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

Search

Description

Gets a list of Domain Registration Orders matching the search criteria, along with the details.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
no-of-records Integer Required Number of Orders to be fetched. This should be a value between 10 to 500.
page-no Integer Required Page number for which details are to be fetched
order-by Array of Strings Optional

One or more parameters by which you want to sort the Orders. Values can be orderid, customerid, endtime, timestamp, entitytypeid, creationtime or creationdt.

Example:

If page-no is 1, no-of-records is 30 and order-by is orderid; it will fetch the first 30 Orders which suit the search criteria sorted by orderid. If page-no is 2, no-of-records
is 30 and order-by is order id; it will fetch the second batch of 30 Orders sorted by orderid.

order-id Array of Integers Optional Order Id(s) of the Domain Registration Order(s) whose details need to be fetched
reseller-id Array of Integers Optional Reseller Id(s) whose Orders need to be fetched
customer-id Array of Integers Optional Customer Id(s) whose Orders need to be fetched
show-child-orders Boolean Optional Whether Sub-Reseller Orders need to be fetched or not
product-key Array of Strings Optional Product keys of the TLDs
status Array of Strings Optional

Status of the Order, namely, InActive, Active, Suspended, Pending Delete Restorable, Deleted, Archived, Pending Verification or Failed Verification

  • Deleted - to be used for searching Orders deleted in the past 30 days

  • Archived - to be used for searching Orders deleted more than 30 days ago

  • Pending Verification - to be used for searching Orders for which the Registrant Contact email address verification is pending

  • Failed Verification - to be used for searching Orders which have been deactivated due to non-verification of the Registrant Contact email address

Additional Information

Whois Data Verification

domain-name String Optional Name of the Domain
privacy-enabled String Optional

Privacy Protection status of the Order, namely, true, false or na

  • true - to be used for searching Orders for which Privacy Protection is enabled

  • false - to be used for searching Orders for which Privacy Protection is disabled

  • na - to be used for searching Orders for which Privacy Protection is not applicable (not allowed). The search results will include Inactive Orders as well.

creation-date-start String Optional UNIX TimeStamp for listing of Domain Registration Orders whose Creation Date is greater than creation-date-start
creation-date-end String Optional UNIX TimeStamp for listing of Domain Registration Orders whose Creation Date is less than creation-date-end
expiry-date-start String Optional UNIX TimeStamp for listing of Domain Registration Orders whose Expiry Date is greater than expiry-date-start
expiry-date-end String Optional UNIX TimeStamp for listing of Domain Registration Orders whose Expiry Date is less than expiry-date-end

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/domains/search.json?auth-userid=0&api-key=key&no-of-records=10&page-no=1

Response

Returns a hash map containing the below details of the Domain Registration Orders which match the search criteria:

  • Domain Name (entity.description)

  • Order Id (orders.orderid)

  • Customer Id (entity.customerid)

  • Order Addition Timestamp (orders.creationdt)

  • Order Creation (at the Registry) Timestamp (orders.creationtime)

  • Timestamp for the Last Modification Action on the Order (orders.timestamp)

  • Expiry (at the Registry) Timestamp (orders.endtime)

  • Current Order Status under the System (entity.currentstatus) - value will be InActive, Active, Suspended, Pending Delete Restorable, Deleted, Archived, Pending Verification or Failed Verification

  • Product Name (entitytype.entitytypename)

  • Product Key (entitytype.entitytypekey)

  • Reseller Lock Status (orders.resellerlock)

  • Customer Lock Status (orders.customerlock)

  • Transfer Lock Status (orders.transferlock)

  • Privacy Protection Status (orders.privacyprotection)

Getting Details of the Domain Registration Order using Order Id

Description

Gets details of the Domain Registration Order associated with the specified Order Id.

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 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, StatusDetails.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/domains/details.json?auth-userid=0&api-key=key&order-id=0&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
StatusDetails entityid, currentstatus, isImmediateReseller, isOrderSuspendedUponExpiry, isprivacyprotected, description, privacyprotectedallowed
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.

Check Availability

Description

Checks the availability of the specified domain name(s).

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name Array of Strings Required Domain name(s) that you need to check the availability for
tlds Array of Strings Required TLDs for which the domain name availability needs to be checked See details

HTTP Method

GET

Example Test URL Request


https://domaincheck.httpapi.com/api/domains/available.json?auth-userid=0&api-key=key&domain-name=domain1&domain-name=domain2&tlds=com&tlds=net

Response

Returns a hash map containing domain name availability status for the requested TLDs:

  • Domain Availability Status (status)

    • available - domain name available for registration

    • regthroughus - domain name currently registered through the Registrar whose connection is being used to check the availability of the domain name

    • regthroughothers - domain name currently registered through a Registrar other than the one whose connection is being used to check the availability of the domain name. If you wish to manage such a domain name through your Reseller / Registrar Account, you may pass a Domain Transfer API call. See details

    • unknown - returned, if for some reason, the Registry connections are not available. You should ideally re-check the domain name availability after some time.

      Note
      • In case of Donuts TLDs, domain name availability can be checked for a maximum of 5 domain names per Donuts TLD group in one API call. Including more than 5 domain names belonging to the same Donuts TLD group in an API call will return the status as unknown for all the domain names.

        Additional Information

        Donuts TLDs

      • In case of .CA TLD, domain name availability can be checked for a maximum of 15 strings in one API call. Including more than 15 strings in an API call will return the status as unknown for all the strings.

  • Trademark Claims Key (tm-claims-key) - will be returned only if the domain name is available and Trademark for that domain name is listed in the Trademark Clearinghouse database

  • Premium Names (costHash) - A hash map will be returned only if the
    domain is a premium name along with the pricing of the domain ("create",
    "renew", "transfer") and the selling currency symbol

  • Early Access Program (costHash) - A hash map will be returned only
    if the domain is in EAP along with the early access fee
    ("early_access_fee") and the selling currency symbol. The early access fee
    is the non-refundable component which needs to added to the selling price
    of the domain

  • Additional Information

    Trademark Claim Process

  • 3rd Level .UK domain name (ror) - will be returned for an available 2nd Level .UK domain name, if the corresponding 3rd Level .UK domain name already exists. Currently, a 2nd Level .UK domain name can only be registered by the person/entity that owns the 3rd Level .UK domain name, if it already exists.

    Note

    For .UK availability check, the API call need to have only one domain name. Otherwise, the ror parameter will not be returned in the result.