domorder

Domain Products

Deleting a Delegation Signer (DS) Record cmu5 Fri, 07/05/2013 - 15:44

Description

Deletes a Delegation Signer (DS) Record for a 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 associated with the domain name for which you want to delete the DS record
attr-name Map[name] Required Mapping key of the details associated with a DS Record. Refer the description of attr-value.
attr-value Map[value] Required

Mapping value of the details associated with a DS Record. This together with attr-name shall contain the details.

  • To delete a DS Record associated with a Domain Registration Order:

    • keytag: Key Tag value associated with the DS Record

    • algorithm: Algorithm associated with the DS Record

    • digesttype: Digest Type associated with the DS Record. Applicable values are 1, 2 & 3 for .COM / .NET and 1 & 2 for other domain name extensions.

    • digest: Digest associated with the DS Record - a 40-character string for Digest Type value 1 and a 64-character string for Digest Type values 2 and 3

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/del-dnssec.xml?auth-userid=0&api-key=key&order-id=0&attr-name1=keytag&attr-value1=123&attr-name2=algorithm&attr-value2=3&attr-name3=digesttype&attr-value3=1&attr-name4=digest&attr-value4=49FD46E6C4B45C55D4AC49FD46E6C4B45C55D111

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 Delete DS Record Action (actiontypedesc)

  • Action ID of the Delete DS Record Action (eaqid)

  • Delete DS Record Action Status (actionstatus)

  • Description of the Delete DS Record Action Status (actionstatusdesc)

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

Adding a Delegation Signer (DS) Record cmu5 Fri, 07/05/2013 - 15:42

Description

Adds a Delegation Signer (DS) Record for a Domain Registration Order.

Note

Currently, supports DS Record only for the following domain name extensions:

  • .COM

  • .IN

  • .ME

  • .NET

  • .ORG

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 associated with the domain name for which you want to add the DS record
attr-name Map[name] Required Mapping key of the details needed to add a DS Record. Refer the description of attr-value.
attr-value Map[value] Required

Mapping value of the details needed to add a DS Record. This together with attr-name shall contain the details.

  • To add a DS Record for a Domain Registration Order:

    • keytag: Contains the tag value of the DNSKEY Resource Record that validates this signature. An integer value in the range 0 to 65536.

    • algorithm: The cryptographic algorithm that is used to generate the signature. An integer value in the range 0 to 255.

    • digesttype: The algorithm type used to construct the Digest. Applicable values are 1, 2 & 3 for .COM / .NET and 1 & 2 for other domain name extensions.

    • digest: An alpha-numeric string generated by applying the Digest Type algorithm to a message. It needs to be a 40-character string for Digest Type value 1 and a 64-character string for Digest Type values 2 and 3.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/add-dnssec.xml?auth-userid=0&api-key=key&order-id=0&attr-name1=keytag&attr-value1=123&attr-name2=algorithm&attr-value2=3&attr-name3=digesttype&attr-value3=1&attr-name4=digest&attr-value4=49FD46E6C4B45C55D4AC49FD46E6C4B45C55D111

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 Add DS Record Action (actiontypedesc)

  • Action ID of the Add DS Record Action (eaqid)

  • Add DS Record Action Status (actionstatus)

  • Description of the Add DS Record Action Status (actionstatusdesc)

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

Modifying the hosts file

What is host file?

A hosts file is an address book, situated on your local desktop, that maps a host name to an IP address (network name resolution). Generally, a domain name (host name) is translated in to IP address via the DNS resolution process. However, the host entries that are present in this file will bypass this DNS resolution.

This can be of great help when:

  • You have modified the Name Servers, and are viewing the cached results due to the DNS propagation delay.

  • You are in process of migrating the hosting server, and want view the website on the new server when its still under development. This way you can preview the site in the developmental stage, whereas your visitors will continue to view the live website on the old server. Thus, the traffic to your site remains unaffected.

    Note

    You can also use the Direct/Temp URL to preview the site on 's server.

    • Creating a hosts file

    To view the results with such immediate effect, you can define a host/domain name in the hosts file.

    For Windows

  1. Go to C:\Windows\System32\drivers\etc and locate the hosts file.

  2. Open it in any text editor like Notepad, Notepad++, etc.

  3. Add your host entires as shown in the snapshot below and save the file.

For Linux

  1. Locate the hosts file at /etc/hosts.

  2. Run the below command to edit file:

    vim /etc/hosts

  3. Add your host entires as shown in the snapshot below and save the file.

Note

You may also need to flush your DNS. Your website's IP address may be saved in your computer's cache. So you need to clear this temporary data so that the IP address you just entered into your hosts file will take effect. To do so:

For Windows

  1. Click your Start Menu.

  2. Go to Accessories and then click Command Prompt.

  3. Run the below command:

    C:\> ipconfig /flushdns

  4. The output would be similar to:

For Linux

  1. Login into the shell of your machine.

  2. Run the below commands:

    root@support [~]# cd /etc/rc.d/init.d
    root@support [/etc/rc.d/init.d]# ./nscd restart

  3. The output would be similar to:

If you have any browsers open, close them and then open them again. You should now be able to successfully test your website on your new server.

Validating Registrant Contact

Description

Validates the Registrant Contact(s) against the eligibility criteria(s) provided.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
contact-id Array of Integers Required The Registrant Contact Id(s) which you want to validate
eligibility-criteria Array of Strings Required

To validate the Registrant Contact(s), pass the appropriate eligibility-criteria(s) corresponding to the domain name extension:



Domain Name Extension Eligibility Criteria Value
.ASIA CED_ASIAN_COUNTRY and CED_DETAILS
.CA CPR
.COOP SPONSORS
.ES ES_CONTACT_IDENTIFICATION_DETAILS
.EU EUROPEAN_COUNTRY
.RU RU_CONTACT_INFO
.US APP_PREF_NEXUS

HTTP Method

GET

Example Test URL


https://test.httpapi.com/api/contacts/validate-registrant.json?auth-userid=0&api-key=key&contact-id=0&contact-id=1&eligibility-criteria=CED_ASIAN_COUNTRY&eligibility-criteria=CED_DETAILS

Response

Returns a hash map containing the Contact Id(s) and validation status for the corresponding eligibility criteria provided.

Check Availability - IDN

Description

Checks the availability of the specified Internationalized Domain Name(s) (IDN).

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

Internationalized Domain Name(s) that you need to check the availability for

Refer to the supported character sets mentioned below:

Note

The domain name used in the API call can be in Unicode (the native language) or in Punycode format.

Example: The domain name can be provided as ѯҋ111 (Unicode) or xn--111-dkd4l (Punycode).

domain-name=ѯҋ111
domain-name=xn--111-dkd4l

tld String Required TLD for which the domain name availability needs to be checked See details
idnLanguageCode String Required

While performing check availability for an Internationalized Domain Name, you need to provide the corresponding language code:

  • .ASIA IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

    • Chinese - zh

    • Japanese - ja

    • Korean - ko

    idnLanguageCode=ko

  • .BIZ IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

    • Chinese - zh

    • Danish - da

    • Finnish - fi

    • German - de

    • Hungarian - hu

    • Icelandic - is

    • Japanese - jp

    • Korean - ko

    • Lithuanian - lt

    • Latvian - lv

    • Norwegian - no

    • Polish - pl

    • Portuguese - pt

    • Spanish - es

    • Swedish - sv

    idnLanguageCode=ko

  • .CA IDN: The language code needs to be mentioned as fr.

    idnLanguageCode=fr

  • .CC / .TV IDN: The language code depends upon the language whose characters are used in the domain name. You can refer to the list of languages supported and the corresponding language code.

    idnLanguageCode=aze

  • .CO IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

    • Chinese - zh

    • Danish - da

    • Finnish - fi

    • Icelandic - is

    • Japanese - jp

    • Korean - ko

    • Norwegian - no

    • Spanish - es

    • Swedish - sv

    idnLanguageCode=da

  • .COM / .NET IDN: The language code depends upon the language whose characters are used in the domain name. You can refer to the list of languages supported and the corresponding language code.

    idnLanguageCode=aze

  • .DE IDN: The language code needs to be mentioned as de.

    idnLanguageCode=de

  • .ES IDN: The language code needs to be mentioned as es.

    idnLanguageCode=es

  • .EU IDN: The language code needs to be mentioned as latin.

    idnLanguageCode=latin

  • .IN.NET IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

    • Arabic - ara

    • Chinese - chi

    • Cyrillic - cyr

    • Greek - gre

    • Hebrew - heb

    • Japanese - jpn

    • Korean - kor

    • Lao - lao

    • Latin - lat

    • Thai - tha

    idnLanguageCode=jpn

  • .INFO IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

    • Danish - da

    • German - de

    • Hungarian - hu

    • Icelandic - is

    • Korean - ko

    • Lithuanian - lt

    • Latvian - lv

    • Polish - pl

    • Spanish - es

    • Swedish - sv

    idnLanguageCode=ko

  • .NAME IDN: The language code depends upon the language whose characters are used in the domain name. You can refer to the list of languages supported and the corresponding language code.

    idnLanguageCode=aze

  • .ORG IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

    • Chinese - zh-cn (for IDN.org domain name and .机构 domain name - the Chinese IDN for .org)

    • Cyrillic - ru (for .орг domain name - the Russian IDN for .org)

    • Danish - da

    • German - de

    • Hindi - hin-deva (for .संगठन domain name - the Hindi IDN for .org)

    • Hungarian - hu

    • Icelandic - is

    • Korean - ko

    • Latvian - lv

    • Lithuanian - lt

    • Polish - pl

    • Spanish - es

    • Swedish - sv

    idnLanguageCode=ko

  • .PW IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

    • Arabic - ara

    • Chinese - chi

    • Cyrillic - cyr

    • Greek - gre

    • Hebrew - heb

    • Japanese - jpn

    • Korean - kor

    • Lao - lao

    • Latin - lat

    • Thai - tha

    idnLanguageCode=tha

  • .TEL IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

    • Chinese - zh

    • Danish - da

    • Finnish - fi

    • French - fr

    • German - de

    • Hungarian - hu

    • Icelandic - is

    • Japanese - jp

    • Korean - ko

    • Latvian - lv

    • Lithuanian - lt

    • Norwegian - no

    • Polish - pl

    • Portuguese - pt

    • Russian - ru

    • Spanish - es

    • Swedish - sv

    idnLanguageCode=ko

  • CentralNic IDN: The language code depends upon the language whose characters are used in the domain name. Supported languages and the corresponding language codes are:

    • .EU.COM:

      • Arabic - ara

      • Cyrillic - cyr

      • Greek - gre

      • Hebrew - heb

      • Latin - lat

    • .GB.COM, .QC.COM, .DE.COM, .GB.NET, .NO.COM, .HU.COM, .UY.COM, .ZA.COM, .BR.COM, .SE.COM, .SE.NET, .UK.COM and .UK.NET:

      • Latin - lat

    • .AE.ORG and .SA.COM:

      • Arabic - ara

    • .KR.COM:

      • Korean - kor

    • .US.COM:

      • Arabic - ara

      • Chinese - chi

      • Cyrillic - cyr

      • Greek - gre

      • Hebrew - heb

      • Japanese - jpn

      • Latin - lat

    • .GR.COM:

      • Greek - gre

    • .JPN.COM:

      • Japanese - jpn

    • .CN.COM:

      • Chinese - chi

    • .RU.COM:

      • Cyrillic - cyr

    idnLanguageCode=lat

  • .在线 (Chinese IDN for .online): The language code needs to be mentioned as zh.

    attr-name1=idnLanguageCode&attr-value1=zh

  • .中文网 (Chinese IDN for .network): The language code needs to be mentioned as zh.

    attr-name1=idnLanguageCode&attr-value1=zh

  • .भारत (Hindi IDN for .BHARAT): The language code needs to be mentioned as hin-deva.

    attr-name1=idnLanguageCode&attr-value1=hin-deva

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/domains/idn-available.json?auth-userid=0&api-key=key&domain-name=ѯҋ111&domain-name=ѯҋ112&tld=com&idnLanguageCode=aze

Response

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

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

Suggest Names

Description

Returns domain name suggestions for a user-specified keyword.

Parameters

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

Search term (keyword or phrase) e.g. "search" or "search world"

Note

  • Allowed characters are a-z, A-Z, 0-9, space and hyphen.

  • The search term will be considered as invalid, if it contains more than one consecutive space character.
tld-only String Optional Specific TLD(s) you may want to search for See details
Note

Name Suggestion is not supported for ccTLDs except:

  • .US

  • .CO (2nd and 3rd level)
exact-match Boolean Optional Will return keyword alternatives when set to True. Can be set to False to only return TLD alternatives.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/domains/v5/suggest-names.json?auth-userid=0&api-key=key&keyword=domain

Response

Returns a hash map containing availability status of suggested domain names for the keyword supplied.

Example Scenarios

  • When tld-only is not specified, and exact-match is false: Results will include keyword matches and alternatives against all TLDs the reseller is signed up for.

  • When tld-only is specified, and exact-match is false: Results will include keyword matches and alternatives against only the TLDs specified.

  • When tld-only is not specified, and exact-match is true: Results will include keyword matches against all TLDs that the reseller is signed up for. No keyword alternatives will be returned.

  • When tld-only is specified, and exact-match is true: Results will include keyword matches against only the TLDs specified. No keyword alternatives will be returned.

Old API call being deprecated

Parameters

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

Search term (keyword or phrase) e.g. "search" or "search world"

Note

The search term will be considered as invalid, if it contains more than one consecutive space character.
tlds Array of Strings Required Domain name extensions (TLDs) you want to search in See details
no-of-results Integer Required Maximum number of suggestions to be returned
hyphen-allowed Boolean Optional Default value is false. Recommended value is true. If true is passed, generates suggestions with hyphens (Dashes) "-".
add-related Boolean Optional Default value is false. Recommended value is true. If true is passed, generates suggestions with related keywords.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/domains/suggest-names.json?auth-userid=0&api-key=key&keyword=domain&tlds=com&tlds=net&no-of-results=0&hyphen-allowed=true&add-related=true

Response

Returns a hash map containing availability status of suggested domain names, for the given keyword under the specified domain name extension(s). The domain name extensions will be listed in alphabetical order.

Session Timeout

Session timeout is a concept that the system uses to define a time period in which a Customer Control Panel session is valid / accessible. This time period is 2 hours. The session timeout ensures that you are logged out of your Customer Control Panel automatically when you are not using it and helps keeping it secure.

You will encounter the below error message in case you try to perform any action and your Customer Control Panel session has timed out:

Attention

You need to be logged in to perform this action.

You need to login to your Customer Control Panel again and perform the desired action.

Home

Welcome to the Support Knowledge Base. Here, we have listed detailed information regarding all our current Product and Service offerings and
answers to possibly all your queries. The Support KB has been divided into categories indicating a particular Interface or a particular Product/Service.
These have been further logically divided into sub-categories and answers, detailing a particular action or query.

Note

In the event, you are unable to locate a particular answer, please make use of the Search box provided on the top-left of the page or inform our Support Team at

Subscribe to domorder