reseller

is added when reseller has a customer specific business

Modify/Upgrade

Description

Modifies/upgrades an existing Single Domain Windows Hosting 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.
months Integer Required The number of months in the new plan for which the Order is to be modified.
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, Texas Server


https://test.httpapi.com/api/singledomainhosting/windows/us/modify.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0&invoice-option=NoInvoice

US, California Server


https://test.httpapi.com/api/singledomainhosting/windows/us/ca/modify.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0&invoice-option=NoInvoice

UK Server


https://test.httpapi.com/api/singledomainhosting/windows/uk/modify.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0&invoice-option=NoInvoice

India Server


https://test.httpapi.com/api/singledomainhosting/windows/in/modify.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0&invoice-option=NoInvoice

Hong Kong Server


https://test.httpapi.com/api/singledomainhosting/windows/hk/modify.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0&invoice-option=NoInvoice

Turkey Server


https://test.httpapi.com/api/singledomainhosting/windows/tr/modify.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0&invoice-option=NoInvoice

Response

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

Renew

Description

Renews an existing 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 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.

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, Texas Server


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

US, California Server


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

UK Server


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

India Server


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

Hong Kong Server


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

Turkey Server


https://test.httpapi.com/api/singledomainhosting/windows/tr/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 Single Domain Windows Hosting 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.
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.
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.

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, Texas Server


https://test.httpapi.com/api/singledomainhosting/windows/us/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&plan-id=0&invoice-option=NoInvoice

US, California Server


https://test.httpapi.com/api/singledomainhosting/windows/us/ca/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&plan-id=0&invoice-option=NoInvoice

UK Server


https://test.httpapi.com/api/singledomainhosting/windows/uk/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&plan-id=0&invoice-option=NoInvoice

India Server


https://test.httpapi.com/api/singledomainhosting/windows/in/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&plan-id=0&invoice-option=NoInvoice

Hong Kong Server


https://test.httpapi.com/api/singledomainhosting/windows/hk/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&plan-id=0&invoice-option=NoInvoice

Turkey Server


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

Get DNS Records

Description

Gets the DNS records of a Single Domain Linux 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 Linux Hosting Order

HTTP Method

GET

Example Test URL Request

US, Texas Server


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

US, California Server


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

UK Server


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

India Server


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

Hong Kong Server


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

Turkey Server


https://test.httpapi.com/api/singledomainhosting/linux/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 Linux 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 Linux 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/linux/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/linux/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/linux/uk/change-password.json?auth-userid=0&api-key=key&order-id=0&new-passwd=password1

India Server


https://test.httpapi.com/api/singledomainhosting/linux/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/linux/hk/change-password.json?auth-userid=0&api-key=key&order-id=0&new-passwd=password1

Turkey Server


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

Get Customer Pricing

Description

Use this method to get details of the pricing for the Single Domain Linux Hosting plans.

Response

Returns a map with the prices of the Single Domain Linux Hosting plans along with the prices of the other products.

The response structure for the Single Domain Linux Hosting will be:


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US, Texas Server


"singledomainhostinglinuxus":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

US, California Server


"singledomainhostinglinuxusca":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

UK Server


"singledomainhostinglinuxuk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

India Server


"singledomainhostinglinuxin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Hong Kong Server


"singledomainhostinglinuxhk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Turkey Server


"singledomainhostinglinuxtr":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Get Modify/Upgrade Price

Description

Gets the applicable modify/upgrade price for a particular Single Domain Linux 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 The OrderId for which the details are to be fetched.
new-plan-id Integer Required The new plan to which the Order is to be upgraded/downgraded. To fetch the plan details: plan-id etc., use this method.
months Integer Required The number of months (tenure) in the new plan for which the Order to be placed.

HTTP Method

GET

Example Test URL Request

US, Texas Server


https://test.httpapi.com/api/singledomainhosting/linux/us/modify-pricing.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0

US, California Server


https://test.httpapi.com/api/singledomainhosting/linux/us/ca/modify-pricing.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0

UK Server


https://test.httpapi.com/api/singledomainhosting/linux/uk/modify-pricing.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0

India Server


https://test.httpapi.com/api/singledomainhosting/linux/in/modify-pricing.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0

Hong Kong Server


https://test.httpapi.com/api/singledomainhosting/linux/hk/modify-pricing.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0

Turkey Server


https://test.httpapi.com/api/singledomainhosting/linux/tr/modify-pricing.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0

Response

Returns the applicable modify/upgrade price for a particular Single Domain Hosting Order.

Example:


{
"upgradecost":0.0,
"modifiedOrderPrice":0.0,
"endtime":"0000000000",
"remainingmonths":0,
"currentOrderPrice":0.0
}

where

  • currentOrderPrice: The current pricing of the Order for remaining months.

  • modifiedOrderPrice: New applicable pricing of the Order as per the new plan.

  • upgradecost: Actual price applicable i.e. modifiedOrderPrice - currentOrderPrice

Search Orders

Description

Gets a list and details of the Single Domain Linux Hosting Orders matching the search criteria.

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.
page-no Integer Required Page number for which details are to be fetched.
order-id Array of Integers Optional Order Id(s) of the Single Domain Linux Hosting 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.
status Array of Strings Optional Status of the Order: Active, InActive, Deleted, etc.
domain-name String Optional Name of the Domain of the Single Domain Linux Hosting Order.
creation-date-start String Optional UNIX TimeStamp for listing of the Single Domain Linux Hosting Orders whose Creation Date is greater than creation-date-start.
creation-date-end String Optional UNIX TimeStamp for listing of the Single Domain Linux Hosting Orders whose Creation Date is less than creation-date-end.
expiry-date-start String Optional UNIX TimeStamp for listing of the Single Domain Linux Hosting Orders whose expiry date is greater than expiry-date-start.
expiry-date-end String Optional UNIX TimeStamp for listing of the Single Domain Linux Hosting Orders whose expiry date is less than expiry-date-end.
order-by Array of Strings Optional One or more parameters by which you want to sort the Orders. Default is orderid.

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

HTTP Method

GET

Example Test URL Request

US, Texas Server


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

US, California Server


https://test.httpapi.com/api/singledomainhosting/linux/us/ca/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1

UK Server


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

India Server


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

Hong Kong Server


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

Turkey Server


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

Response

Returns the list of the Single Domain Linux Hosting Orders which match the search criteria.

Get Order Id

Description

Gets the associated Single Domain Linux Hosting Order Id from the 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 Id is to be fetched.

HTTP Method

GET

Example Test URL Request

US, Texas Server


https://test.httpapi.com/api/singledomainhosting/linux/us/orderid.json?auth-userid=0&api-key=key&domain-name=domainname.asia

US, California Server


https://test.httpapi.com/api/singledomainhosting/linux/us/ca/orderid.json?auth-userid=0&api-key=key&domain-name=domainname.asia

UK Server


https://test.httpapi.com/api/singledomainhosting/linux/uk/orderid.json?auth-userid=0&api-key=key&domain-name=domainname.asia

India Server


https://test.httpapi.com/api/singledomainhosting/linux/in/orderid.json?auth-userid=0&api-key=key&domain-name=domainname.asia

Hong Kong Server


https://test.httpapi.com/api/singledomainhosting/linux/hk/orderid.json?auth-userid=0&api-key=key&domain-name=domainname.asia

Turkey Server


https://test.httpapi.com/api/singledomainhosting/linux/tr/orderid.json?auth-userid=0&api-key=key&domain-name=domainname.asia

Response

Returns the associated Single Domain Linux Hosting Order Id (Integer) of the domain name.

Subscribe to reseller