reseller

is added when reseller has a customer specific business

Delete Dedicated IP

Description

Deletes the specified dedicated IP(s) of the Reseller 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 Order ID for which the specified dedicated IP(s) to be deleted.
ips Array of Strings Required Dedicated IP(s) you want to delete.

HTTP Method

POST

Example Test URL Request

US Server


https://test.httpapi.com/api/resellerhosting/windows/us/delete-dedicated-ip.json?auth-userid=0&api-key=key&order-id=0&ips=0.0.0.0&ips=1.1.1.1

UK Server


https://test.httpapi.com/api/resellerhosting/windows/uk/delete-dedicated-ip.json?auth-userid=0&api-key=key&order-id=0&ips=0.0.0.0&ips=1.1.1.1

India Server


https://test.httpapi.com/api/resellerhosting/windows/in/delete-dedicated-ip.json?auth-userid=0&api-key=key&order-id=0&ips=0.0.0.0&ips=1.1.1.1

Turkey Server


https://test.httpapi.com/api/resellerhosting/windows/tr/delete-dedicated-ip.json?auth-userid=0&api-key=key&order-id=0&ips=0.0.0.0&ips=1.1.1.1

Response

Returns a map of the execution details of the deleting dedicated IP(s) operation.

Add Dedicated IP

Description

Adds a dedicated IP for an existing Reseller 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 Order ID for which a dedicated IP to be added.
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 Server


https://test.httpapi.com/api/resellerhosting/windows/us/add-dedicated-ip.json?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice

UK Server


https://test.httpapi.com/api/resellerhosting/windows/uk/add-dedicated-ip.json?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice

India Server


https://test.httpapi.com/api/resellerhosting/windows/in/add-dedicated-ip.json?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice

Turkey Server


https://test.httpapi.com/api/resellerhosting/windows/tr/add-dedicated-ip.json?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice

Response

Returns a map of the execution details of the adding dedicated IP operation.

Modify/Upgrade

Description

Modifies/upgrades an existing Reseller 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 Order ID 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 Server


https://test.httpapi.com/api/resellerhosting/windows/us/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/resellerhosting/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/resellerhosting/windows/in/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/resellerhosting/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 Reseller 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 Order ID which is to be renewed.
months Integer Required The number of months for which the Order is to be renewed.
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 Server


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

UK Server


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

Turkey Server


https://test.httpapi.com/api/resellerhosting/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 Reseller 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 to be 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 to be 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.
add-dedicated-ip 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 Server


https://test.httpapi.com/api/resellerhosting/windows/us/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/resellerhosting/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/resellerhosting/windows/in/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/resellerhosting/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.

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.