reseller

is added when reseller has a customer specific business

Validating a Transfer Request

Description

Checks if a transfer request is valid 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 Domain name for which you want to check if the transfer request is valid.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/domains/validate-transfer.json?auth-userid=0&api-key=key&domain-name=domain.com

Response

Returns true (String) if the transfer request is valid. Returns false otherwise.

Rechecking NS with .DE Registry

Description

Recheck zone configuration with .DE Registry of the expired .DE Domain Registration 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 .DE Domain Registration Order whose zone configuration needs to be rechecked.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/de/recheck-ns.json?auth-userid=0&api-key=key&order-id=0

Response

Returns a hash map containing the below details:

  • Zone successfully updated at the Registry: A status key with value as success

  • Zone not updated at the Registry: A status key with value as failed and a description key with value as Invalid Name Servers or Zone records. Please re-check your settings

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

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&[email protected]&[email protected],[email protected]

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&[email protected]&[email protected],[email protected]

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 protected]

Response

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

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.

Modifying NS Record

Description

Modifies a Name Server (NS) 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 NS record
host String Optional

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

Example:

You may send this as ns1, if u wish to modify the NS record as ns1.domainname.com.
current-value String Required Current NS value
new-value String Required New NS 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-ns-record.json?auth-userid=0&api-key=key&domain-name=domain.asia&current-value=ns1.domain.com&new-value=ns2.domain.com

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.

Subscribe to reseller