reseller

is added when reseller has a customer specific business

Search Transactions of Reseller

Description

Gets a detailed list of Reseller's Transactions, matching the search criteria.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
transaction-type Array of Strings Optional Type of the Transactions. Possible values can be credit, debit, invoice, receipt.
transaction-key String Optional Transaction key. Possible value can be manually or systemgenerated.
transaction-id Array of Integers Optional Transaction Ids
balance-type String Optional

Payment status for the Transaction. Possible values can be:

  • onlybalanced: Will fetch all transactions that have been balanced or paid for

  • onlyunbalanced: Will fetch all transactions that are yet to be balanced or paid

If this parameter is not included in the API call, all Transactions (balanced as well as unbalanced) will be fetched.

transaction-description String Optional Transaction description
amt-range-start Integer Optional Lowest amount in the range of Transactions you intend to list
amt-range-end Integer Optional Highest amount in the range of Transactions you intend to list
transaction-date-start String Optional UNIX TimeStamp for listing of Transactions whose Creation Date is greater than transaction-date-start
transaction-date-end String Optional UNIX TimeStamp for listing of Transactions whose Creation Date is less than transaction-date-end
no-of-records Integer Required Number of Transactions to be fetched
page-no Integer Required Page number for which details are to be fetched
order-by Array of Strings Optional One or more parameters by which you want to sort the Transactions.

Example: If page-no is 1, no-of-records is 30 and order-by is transaction-id; it will fetch the first 30 Transactions which match the search criteria sorted by transaction-id. If page-no is 2, no-of-records is 30 and order-by is transaction-id; it will fetch the second batch of 30 Transactions sorted by transaction-id.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/billing/my-transactions/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1

Response

Returns a hash map of the Reseller's Transactions containing the below details:

  • Transaction Id (transid)

  • Transaction Date (transactiondate)

  • Product Key (key)

  • Transaction Type (type)

  • Transaction Description (description)

  • Whether Transaction is Greedy (greedy)

  • Selling Currency Symbol of the Parent Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Reseller Chain by RID (parentkey)

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

Get DNS Records

Description

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

HTTP Method

GET

Example Test URL Request

US Server


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


India Server


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

Response

Returns DNS records of the Cloud Hosting Order.

Disable Shell Access

Description

Disables Shell Access for an existing Cloud 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 shell access is to be disabled.

HTTP Method

POST

Example Test URL Request

US Server

https://test.httpapi.com/api/cloudsites/linux/us/disable-shell-access.json?auth-userid=0&api-key=key&order-id=0

India Server

https://test.httpapi.com/api/cloudsites/linux/in/disable-shell-access.json?auth-userid=0&api-key=key&order-id=0

Response

Returns a map of the execution details of the Disable Shell Access operation.

Enable Shell Access

Description

Enables Shell Access for an existing Cloud 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 shell access is to be enabled.

HTTP Method

POST

Example Test URL Request

US Server

https://test.httpapi.com/api/cloudsites/linux/us/enable-shell-access.json?auth-userid=0&api-key=key&order-id=0

India Server

https://test.httpapi.com/api/cloudsites/linux/in/enable-shell-access.json?auth-userid=0&api-key=key&order-id=0

Response

Returns a map of the execution details of the Enable Shell Access operation.

Add Add-on

Description

Adds the specified Add-on for an existing Cloud 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 Order for which the specified Add-on(s) is/are to be added
addon String Required Add-ons can be one of the following:
  • cpu_1
  • ram_1
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/cloudsites/linux/us/addon/add.json?auth-userid=0&api-key=key&order-id=0&addon=cpu_1&invoice-option=NoInvoice


India Server


https://test.httpapi.com/api/cloudsites/linux/in/addon/add.json?auth-userid=0&api-key=key&order-id=0&addon=cpu_1&invoice-option=NoInvoice

Response

Returns a map of the execution details of the adding Add-on operation.

Note

IP addresses cannot be provisioned using the API calls. Please contact our Support team at in case you wish to add an IP address to your order.

Delete Add-on

Description

Deletes the specified Add-on of the Cloud 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 Order for which the specified Add-on is to be deleted
addon-id Integer Required ID of the Add-on to be deleted. Use this method to fetch the Add-on ID.

HTTP Method

POST

Example Test URL Request

US Server


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


India Server


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

Response

Returns a map of the execution details of the Delete Add-on operation.

Get Reseller Pricing

Description

Use this method to get details of the pricing for the Cloud Hosting plans for your Sub-Resellers.

Response

Returns a map with the prices of the Cloud Hosting plans along with the prices of the other products.

The response structure for the Cloud Hosting will be:


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

Example:


{"cloudsites":{"plans":{"300109":{"renew":{"24":33.99,"12":20.99},"add":{"24":2.99,"12":20.99}},"300108":{"add":{"12":0.0}},"300110":{"renew":{"12":20.99},"add":{"12":20.99}}}}}

Get Customer Pricing

Description

Use this method to get details of the pricing for the Cloud Hosting plans for your Customers.

Response

Returns a map with the prices of the Cloud Hosting plans along with the prices of the other products.

The response structure for the Cloud Hosting will be:


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

Example:


{"cloudsites":{"plans":{"300109":{"renew":{"24":33.99,"12":20.99},"add":{"24":2.99,"12":20.99}},"300108":{"add":{"12":0.0}},"300110":{"renew":{"12":20.99},"add":{"12":20.99}}}}}

Change Hosting Panel Password

Description

Changes the hosting panel password of the specified Cloud 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 Cloud Hosting Order whose hosting panel password needs to be changed.
new-passwd String Required New password.

HTTP Method

POST

Example Test URL Request

US Server


https://test.httpapi.com/api/cloudsites/linux/us/change-password.json?auth-userid=0&api-key=key&order-id=0&new-passwd=password1


India Server


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

Search Orders

Description

Gets a list and details of the Cloud 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 Cloud 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 Cloud Hosting Order.
creation-date-start String Optional UNIX TimeStamp for listing of the Cloud Hosting Orders whose Creation Date is greater than creation-date-start.
creation-date-end String Optional UNIX TimeStamp for listing of the Cloud Hosting Orders whose Creation Date is less than creation-date-end.
expiry-date-start String Optional UNIX TimeStamp for listing of the Cloud Hosting Orders whose expiry date is greater than expiry-date-start.
expiry-date-end String Optional UNIX TimeStamp for listing of the Cloud 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 Server


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


India Server


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

Response

Returns the list of the Cloud Hosting Orders which match the search criteria.