reseller

is added when reseller has a customer specific business

Modify/Upgrade

Description

Modifies/upgrades an existing Web Services Order.

Parameters

Name Data Type Required / Optional
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The OrderId which is to be modified.
new-plan-id Integer Required The new Plan to which the order is to be upgraded/downgraded. To fetch the Plan details i.e. plan-id etc, use this method.
Note
  • The new Plan category can be websitebuilder_plan or email_plan.

  • The new Plan category can be linux_hosting_plan only if the current Plan category is linux_hosting_plan. Similarly, the new Plan category can be windows_hosting_plan only if the current Plan category is windows_hosting_plan. In all other cases, an exception will be thrown if the new Plan category is linux_hosting_plan or windows_hosting_plan.

months Integer Required The number of months in the new Plan for which the Order is to be placed.
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/modify.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0&invoice-option=PayInvoice

Response

Returns a map of the execution details of the modify operation.

Renew

Description

Renews an existing Web Services 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 OrderId which is to be renewed.
months Integer Required The number of months for which the Order is to be renewed.
enable-ssl Boolean Optional Values can be: true or false (default). To learn more, click here.
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order.

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/renew.json?auth-userid=0&api-key=key&order-id=0&months=0&invoice-option=NoInvoice

Response

Returns a map of the execution details of the Renew operation.

Add

Description

Places a Web Services Order for the specified domain name. An Order can be either Email only or Website Builder.

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.
plan-id Integer Required The Plan under which the Order should be added. To fetch the Plan details i.e. plan-id etc., use this method.
Note

The Plan category can be websitebuilder_plan or email_plan. An exception will be thrown if the Plan category is linux_hosting_plan or windows_hosting_plan.

enable-ssl Boolean Optional Values can be: true or false (default). To learn more, click here.
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order.

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/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&plan-id=0&invoice-option=NoInvoice

Response

Returns a map with the execution details of the Order addition.

Email, Legacy Web Hosting and Website Builder

Web Services Plans provide you with methods to add, renew, upgrade/modify, suspend, delete and get the details and the pricing for the Website Builder plans.

Note

The Legacy Linux, Windows Hosting Products and Email only plans offered by have been deprecated w.e.f. April 16, 2013 and Feb 2, 2015 respectively. You may only renew, suspend, delete, get the details and the pricing for these Products Plans.

Get Plan Details

Description

Gets the details of the all active product plans of the Reseller.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
product-key String Optional Product key of the product for which the details are to be fetched

HTTP Method

GET

Example Test URL

https://test.httpapi.com/api/products/plan-details.json?auth-userid=0&api-key=key

Response

Returns a map with the details of all the product plan of the Reseller.

Delete Child Name Servers

Description

Deletes the IP address associated with the specified Child Name Server of the particular Domain Registration Order.

Parameters

Name Data Type Required Description
auth-userid Integer Yes Authentication Parameter
api-key String Yes Authentication Parameter
order-id Integer Yes Order Id of the Domain Registration Order.
cns String Yes Child Name Server's name for which the IP address needs to be deleted.
ip Array of Strings Yes IP address that needs to be deleted.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/delete-cns-ip.xml?auth-userid=0&api-key=key&order-id=0&cns=ns1.domain.asia&ip=1.2.3.4

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 IP Deletion Action (actiontypedesc)

  • Action ID of the Child Name Server IP Deletion Action (eaqid)

  • Child Name Server IP Deletion Action Status (actionstatus)

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

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

Modifying a Sub-Reseller's Profile Details

You may update your Sub-Reseller's Profile Details by following the below mentioned process:

  1. Login to your Reseller Control Panel. See details

  2. Go to Sub-Resellers -> Search and search for the Sub-Reseller based on one of the search fields available.

  3. From the list, click the Name link of the Sub-Reseller you are looking for.

  4. In the Sub-Reseller Details view that follows, click the Modify button.

  5. Here, you can modify the Sub-Reseller's Profile Details.

  6. Click the Modify button to submit the changes.

Note
  • This process allows you to modify your Sub-Reseller's Email Address (Username of his Control Panel) if the existing Email Address is no longer in use or your Sub-Reseller has lost control over it.

  • The Personal Identification Number (PIN) of your Sub-Reseller cannot be modified.

Modifying a Customer's Profile Details

You may update your Customer's Profile Details by following the below mentioned process:

  1. Login to your Reseller Control Panel. See details

  2. Go to Customers -> Search and search for the Customer based on one of the search fields available.

  3. From the list, click the Name link of the Customer you are looking for.

  4. In the Customer Details view that follows, click the Modify button.

  5. Here, you can modify the Customer's Profile Details.

  6. Click the Modify button to submit the changes.

Note
  • This process allows you to modify your Customer's Email Address (Username of his Control Panel) if the existing Email Address is no longer in use or your Customer has lost control over it.

  • The Personal Identification Number (PIN) of your Customer cannot be modified.

Searching Archived Actions

Description

Searches the Archived Actions based on the criteria specified.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
eaq-id Array of Integers Optional The Entity Action Queue Ids of the corresponding actions
order-id Array of Integers Optional The Order Ids for which you want to search actions
entity-type-id Array of Integers Optional The Entity Type Ids for which you want to search actions
action-status Array of Strings Optional The action statuses for which you want to search actions
action-type Array of Strings Optional The action types for which you want to search actions
no-of-records Integer Required Number of records to be returned
page-no Integer Required Page number for which records are required

HTTP Method

GET

Example Test URL Request

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

Response

Returns a hash map of the Archived Actions containing the below details:

  • Order Id (entityid)

  • Entity Type Id (entitytypeid)

  • Entity Action Queue Id (eaqid)

  • Action Type (actiontype)

  • Description of the Action (actiontypedesc)

  • Timestamp when the Action was added (actionadded)

  • Timestamp when the Action started (actionstarted)

  • Timestamp when the Action got completed (actioncompleted)

  • Action Status (actionstatus)

  • Description of the Action Status (actionstatusdesc)

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

Searching Current Actions

Description

Gets the Current Actions based on the criteria specified.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
eaq-id Array of Integers Optional The Entity Action Queue Ids of the corresponding actions
order-id Array of Integers Optional The Order Ids for which you want to search actions
entity-type-id Array of Integers Optional The Entity Type Ids for which you want to search actions.
action-status Array of Strings Optional The action statuses for which you want to search actions.
action-type Array of Strings Optional The action types for which you want to search actions
no-of-records Integer Required Number of records to be returned
page-no Integer Required Page number for which records are required

HTTP Method

GET

Example Test URL Request

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

Response

Returns a hash map of the Current Actions containing the below details:

  • Order Id (entityid)

  • Entity Type Id (entitytypeid)

  • Entity Action Queue Id (eaqid)

  • Action Type (actiontype)

  • Description of the Action (actiontypedesc)

  • Timestamp when the Action was added (actionadded)

  • Timestamp when the Action started (actionstarted)

  • Timestamp when the Action got completed (actioncompleted)

  • Action Status (actionstatus)

  • Description of the Action Status (actionstatusdesc)

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