reseller

is added when reseller has a customer specific business

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.

Get DNS Records

Description

Gets the DNS records of a Web Service Order to manage the email service.

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, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/mail/domain/dns-records.json?auth-userid=0&api-key=key&order-id=0

Response

Returns DNS records of the domain name.

Unsuspend

Description

Removes the Suspension on 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 of the Order for which the Suspension is to be removed

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/orders/unsuspend.json?auth-userid=0&api-key=key&order-id=0

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 Order Unsuspension Action (actiontypedesc)

  • Action ID of the Order Unsuspension Action (eaqid)

  • Order Unsuspension Action Status (actionstatus)

  • Description of the Order Unsuspension Action Status (actionstatusdesc)

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

Suspend

Description

Applies the Suspension on 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 of the Order on which the Suspension is to be applied
reason String Required The reason for the suspension.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/orders/suspend.json?auth-userid=0&api-key=key&order-id=0&reason=reason-for-suspension

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Order to be suspended (entityid)

  • Action Type (actiontype)

  • Description of the Order Suspension Action (actiontypedesc)

  • Action ID of the Order Suspension Action (eaqid)

  • Order Suspension Action Status (actionstatus)

  • Description of the Order Suspension Action Status (actionstatusdesc)

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

Get Catch-all Account

Description

Gets email address of a catch-all account of a domain.

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, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/mail/domain/catchall.json?auth-userid=0&api-key=key&order-id=0

Response

Returns catch-all email address if catch-all account is activated on the domain.

Enable SSL

Description

Enables SSL for an existing Web Hosting Order. To learn more, click here.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The OrderId for which SSL needs to be enabled.
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


https://test.httpapi.com/api/webservices/enable-ssl.json?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice

Response

Returns a map of the execution details of the enabling of SSL operation.

Getting .CA Registrant Agreement cmu1 Thu, 10/21/2010 - 18:59

Description

Gets the Registrant Agreement mandated by the Canadian Internet Registration Authority (CIRA).

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/contacts/dotca/registrantagreement.xml?auth-userid=0&api-key=key

Response

Returns the Registrant Agreement and its Version number.

Note

It is mandatory for the Reseller to display the latest version of the CIRA Registrant Agreement and have each Registrant agree to the same, prior to registering a domain name.

Delete Mailing List

Description

Deletes mailing lists.

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, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
list-address-prefixes String Required A CSV of list address prefixes to be deleted on a particular domain name.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/mailinglist/delete.json?auth-userid=0&api-key=key&order-id=0&list-address-prefixes=list1,list2

Response

Returns "SUCCESS" as the status if a mailing list deleted successfully.

Subscribe to reseller