reseller

is added when reseller has a customer specific business

Getting Plan Details

Description

Use this method to get details of your plans.

Response

Returns the details of the plans of Multi Domain Linux Hosting product along with the plan details of other Products of the reseller.

Example:

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

US, Texas Server


multidomainhosting

{

"plan-id(value)"

{

"plan details keys" => "plan details values"

}

}

US, California Server


multidomainhostinglinuxusca

{

"plan-id(value)"

{

"plan details keys" => "plan details values"

}

}

UK Server


multidomainhostinglinuxuk

{

"plan-id(value)"

{

"plan details keys" => "plan details values"

}

}

India Server


multidomainhostinglinuxin

{

"plan-id(value)"

{

"plan details keys" => "plan details values"

}

}

Hong Kong Server


multidomainhostinglinuxhk

{

"plan-id(value)"

{

"plan details keys" => "plan details values"

}

}

Turkey Server


multidomainhostinglinuxtr

{

"plan-id(value)"

{

"plan details keys" => "plan details values"

}

}

Delete

Description

Deletes an existing Multi 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 which is to be deleted.

HTTP Method

POST

Example Test URL Request

US, Texas Server


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

US, California Server


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

UK Server


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

India Server


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

Hong Kong Server


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

Turkey Server


https://test.httpapi.com/api/multidomainhosting/linux/tr/delete.json?auth-userid=0&api-key=key&order-id=0

Response

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

Enable SSL

Description

Enables SSL for an existing Multi Domain Linux 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

US, Texas Server


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

US, California Server


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

UK Server


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

India Server


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

Hong Kong Server


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

Turkey Server


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

Modify/Upgrade

Description

Modifies/upgrades an existing Multi Domain Linux 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/multidomainhosting/linux/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/multidomainhosting/linux/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/multidomainhosting/linux/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/multidomainhosting/linux/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/multidomainhosting/linux/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/multidomainhosting/linux/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 Multi 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 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

US, Texas Server


https://test.httpapi.com/api/multidomainhosting/linux/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/multidomainhosting/linux/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/multidomainhosting/linux/uk/renew.json?auth-userid=0&api-key=key&order-id=0&months=0&invoice-option=NoInvoice

India Server


https://test.httpapi.com/api/multidomainhosting/linux/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/multidomainhosting/linux/hk/renew.json?auth-userid=0&api-key=key&order-id=0&months=0&invoice-option=NoInvoice

Turkey Server


https://test.httpapi.com/api/multidomainhosting/linux/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 Multi Domain Linux 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.

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/multidomainhosting/linux/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/multidomainhosting/linux/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/multidomainhosting/linux/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/multidomainhosting/linux/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/multidomainhosting/linux/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/multidomainhosting/linux/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.

Multi Domain Hosting cmu3 Wed, 08/10/2011 - 19:44

Managing Domain Forwarding Service

Description

Updates settings of the Domain Forwarding 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 for which settings of the Domain Forwarding service needs to be updated
forward-to String Required URL where you want to forward your request.
url-masking Boolean Optional Possible values are true or false. If true passed, visitors will see the source URL and not the destination URL.
meta-tags String Optional

Sets META Tags and Page Title for the frames page which is sent to the visitor. eg. <title>Your Webpage title can be mentioned here</title><meta name="keywords" CONTENT="Your comma-separated keywords are entered here"><meta name="description" CONTENT="Enter website description here">

noframes String Optional

Sets alternate <NOFRAMES> page content for search engines. Provide your HTML within <NOFRAMES></NOFRAMES> tags to set alternate page content.

sub-domain-forwarding Boolean Optional Possible values are true or false. For e.g. if true passed, a request made to http://subdomain.domainname.com will be forwarded to http://destination-domainname.com/subdomain
path-forwarding Boolean Optional Possible values are true or false. For e.g. if true passed, a request made to http://domainname.com/some/path will be forwarded to http://destination-domainname.com/some/path

HTTP Method

POST

Example Test URL Request

https://test.httpapi.com/api/domainforward/manage.xml?auth-userid=0&api-key=key&order-id=0

Response

Returns a map containing "Success" as status if the settings updated successfully.

Getting Details of Domain Forwarding Service

Description

Gets details of the Domain Forwarding 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 for which details of the Domain Forwarding service need to be fetched

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/domainforward/details.xml?auth-userid=0&api-key=key&order-id=0

Response

Returns a map containing details of the Domain Forwarding service.

Deleting SRV Record

Description

Deletes a Service (SRV) record.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name String Required Domain name for which you want to delete a SRV record
host String Required

A fully qualified Service name consisting of:

  • Service Record

  • Protocol

  • Domain Name

This is mentioned as _._.domain-name.com

Example:

_chat._tcp.domain-name.com.

value String Required The hostname of the machine providing the service
port Integer Required The port number of the service
weight Integer Required A relative weight for records with the same priority

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/dns/manage/delete-srv-record.json?auth-userid=0&api-key=key&domain-name=domain.com&host=_chat._tcp.domain-name.com&value=chat.domain.com&port=0000&weight=0

Response

Returns Success as the status of the response if the record is deleted successfully or record does not exist.

In case of any error, an error key with error description (as value) will be returned.