reseller

is added when reseller has a customer specific business

Search

Description

Gets details of the Sub-Resellers that match 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 records to be fetched. This should be a value between 10 to 500.
page-no Integer Required Page number for which details are to be fetched
reseller-id Array of Integers Optional Reseller Id of Sub-Reseller(s)
username String Optional Username of Sub-Reseller. Username should be an email address.
name String Optional Name of Sub-Reseller
company String Optional Company Name of Sub-Reseller
city String Optional City
state String Optional State
status String Optional Status of Sub-Reseller. Values can be Active, Suspended and Deleted.
creation-date-start String Optional UNIX TimeStamp for listing of Sub-Resellers whose Creation Date is greater than creation-date-start
creation-date-end String Optional UNIX TimeStamp for listing of Sub-Resellers whose Creation Date is less than creation-date-end
total-receipt-start Float Optional Total receipts of Sub-Resellers which is greater than total-receipt-start
total-receipt-end Float Optional Total receipts of Sub-Resellers which is less than total-receipt-end

HTTP Method

GET

Example Test URL Request


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

Response

Returns a hash map containing the below details of the Sub-Resellers that match the search criteria:

  • Number of Sub-Resellers requested matching the search criteria (recsonpage)

    Following details of each Sub-Resellers

    • Reseller Id (reseller.resellerid)

    • Username (reseller.username)

    • Name (reseller.name)

    • Company (reseller.company)

    • City (reseller.city)

    • State (reseller.state)

    • Country Code (reseller.country)

    • Current Status (reseller.resellerstatus)

    • Total Receipts (reseller.totalreceipts)

  • Number of Sub-Resellers in the System matching the search criteria (recsindb)

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

Search

Description

Gets a list of Digital Certificate Orders matching the search criteria, along with the details.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key or auth-password String Required Authentication Parameter
no-of-records Integer Required Number of Orders to be fetched. This should be a value between 10 to 500.
page-no Integer Required Page number for which details are to be fetched.
order-id Array of Integers Optional Order Id(s) of the Digital Certificate 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, namely, Active, Deleted etc.
domain-name String Optional Name of the Domain.
cert-key String Required Specifies the type of Digital Certificate. Values can be:
  • sgc

  • ssl

  • fssl

  • wild

creation-date-start String Optional UNIX TimeStamp for listing of Digital Certificate Orders whose Creation Date is greater than creation-date-start.
creation-date-end String Optional UNIX TimeStamp for listing of Digital Certificate Orders whose Creation Date is less than creation-date-end.
expiry-date-start String Optional UNIX TimeStamp for listing of Digital Certificate Orders whose Expiry Date is greater than expiry-date-start.
expiry-date-end String Optional UNIX TimeStamp for listing of Digital Certificate Orders whose Expiry Date is less than expiry-date-end.

HTTP Method

GET

Example Test URL Request


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

Response

Returns the details of the Digital Certificate Orders which match the search criteria.

Delete Moderators

Description

Deletes moderators from the specified mailing list.

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 Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
list-address String Required Mailing list address
moderators String Required A CSV list of email addresses

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/mailinglist/delete-moderators.json?auth-userid=0&api-key=key&order-id=0&list-address=list1@domainname.com&moderators=user1@domainname.com,user2@domainname.com

Response

Returns "SUCCESS" as the status if moderators deleted from the specified mailing list successfully.

Add Moderators

Description

Adds moderators to the specified mailing list.

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 Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
list-address String Required Mailing list address
moderators String Required A CSV list of email addresses

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/mailinglist/add-moderators.json?auth-userid=0&api-key=key&order-id=0&list-address=list1@domainname.com&moderators=user1@domainname.com,user2@domainname.com

Response

Returns "SUCCESS" as the status if moderators added to the specified mailing list successfully.

Reset Password

Description

Resets password of a user.

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 Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
email String Required Email address of a user

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/user/reset-password.json?auth-userid=0&api-key=key&order-id=0&email=username@domainname.com

Response

Returns "SUCCESS" as the status along with a new password if password changed successfully.

Getting a Sub-Reseller's Available Balance

Description

Gets the Available Balance of the specified Sub-Reseller.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
reseller-id Integer Required Reseller Id of the Sub-Reseller whose Available Balance is to be fetched

HTTP Method

GET

Example Test URL Request

https://test.httpapi.com/api/billing/reseller-balance.json?auth-userid=0&api-key=key&reseller-id=0

Response

Returns a hash map of the Sub-Reseller's Available Balance containing the below details:

  • Selling Currency Symbol of the Parent Reseller (sellingcurrencysymbol)

  • Available Balance Amount in the Selling Currency (sellingcurrencybalance)

  • Locked Amount in the Selling Currency (sellingcurrencylockedbalance)

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

Deleting DNS Record (Deprecated)

Description

Deletes the specified record.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
host String Required Hostname of the record to be deleted
value String Required Value of the record to be deleted

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/dns/manage/delete-record.json?auth-userid=0&api-key=key&domain-name=domain.com&host=ns&value=ns1.domain.com

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.

Searching DNS Records

Description

Searches records based on the specified criteria.

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 whose DNS record(s) you want to search
type String Required

Type of record. Values may be:

  • A

  • MX

  • CNAME

  • TXT

  • NS

  • SRV

  • AAAA

no-of-records Integer Required Number of Resource Records to be fetched
page-no Integer Required Page number for which details are to be fetched
host String Optional Hostname of the record
value String Optional Value of the record

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/dns/manage/search-records.json?auth-userid=0&api-key=key&domain-name=domain.asia&type=A&no-of-records=10&page-no=1

Response

Returns the details of the DNS records, which match the specified criteria.

Modifying SRV Record

Description

Modifies 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 modify the 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.

current-value String Required Current hostname of the machine providing the service
new-value String Required New hostname of the machine providing the service
ttl Integer Optional Number of seconds the record needs to be cached by the DNS Resolvers. Default value is 14400.
priority Integer Optional The Priority of the host. Value ranges from 0 to 65535.
port Integer Optional The Port number of the service
weight Integer Optional A relative weight for records with the same priority

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/dns/manage/update-srv-record.json?auth-userid=0&api-key=key&domain-name=domain.asia&host=_chat._tcp.domain-name.com&current-value=chat.domain.com&new-value=chat2.domain.com

Response

Returns "Success" as the status of the response if the record is modified successfully.

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

Modifying TXT Record

Description

Modifies a Text (TXT) 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 modify the TXT record
host String Optional

The host part of the domain-name for which you need to modify a TXT record

Example:

You may send this as www, if u wish to modify the TXT record for www.domainname.com.

current-value String Required Current TXT value
new-value String Required New TXT value
ttl Integer Optional Number of seconds the record needs to be cached by the DNS Resolvers. Default value is 14400.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/dns/manage/update-txt-record.json?auth-userid=0&api-key=key&domain-name=domain.asia&current-value=Mail Server&new-value=Chat Server

Response

Returns a status key with value as Success if the record is modified successfully.

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