Knowledgebase

Portal Home > Knowledgebase > Domain Reseller API > API Actions


API Actions




RegisterDomain:

This command is used to send a Register command to the registrar.

Request Parameters
NameTypeRequired?Description
sld String Yes Domain name
tld String Yes Suffix attached to domain name
regperiod Number Yes Registration period
nameserver1 String No First nameserver
nameserver2 String No Second nameserver
nameserver3 String No Third nameserver
nameserver4 String No Fourth nameserver
nameserver5 String No Fifth nameserver
dnsmanagement Number No Enables dns management for this domain
emailforwarding Number No Enables email forwarding for this domain
idprotection Number No Enables id protection for this domain
firstname String Yes First name of the user
lastname String Yes Last name of the user
address1 String Yes First part of user address
address2 String No Second part of user address
city String Yes City of the user
state String Yes State/Province of the user
postcode String Yes Postal/ZIP Code of the user
country String Yes Country of the user
phonenumber String Yes Phone number in the format +NNN.NNNNNNNNNN
email String Yes Email address of the user
adminfirstname String No First name of the admin user
adminlastname String No Last name of the admin user
adminaddress1 String No First part of admin user address
adminaddress2 String No Second part of admin user address
admincity String No City of the admin user
adminstate String No State/Province of the admin user
adminpostcode String No Postal/ZIP Code of the admin user
admincountry String No Country of the admin user
adminphonenumber String No Phone number in the format +NNN.NNNNNNNNNN
adminemail String No Email address of the admin user
domainfields String No A base64 encoded serialized array of the TLD specific field values
Example Request:
curl 'http://www.domainresellers.co.za/domainsResellerAPI/api.php' --data
 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&action=
RegisterDomain&sld=exampledomain&tld=com&regperiod=1&nameserver1=
ns1.yourdomain.com&nameserver2=ns2.yourdomain.com&firstname=test&lastname=
test&companyname=company&address1=addresss&city=city&state=region&country=
US&postcode=12345&phonenumber=1234567890&email=admin@exampledomain.com' 
--compressed
Example Response:
{"result":"success","msg":"Domain has been registered"}

TransferDomain

This command is used to send a Transfer command to the registrar.

Request Parameters
NameTypeRequired?Description
sld String Yes Domain name
tld String Yes Suffix attached to domain name
transfersecret String No Domain authorization code
regperiod Number Yes Registration period
nameserver1 String No First nameserver
nameserver2 String No Second nameserver
nameserver3 String No Third nameserver
nameserver4 String No Fourth nameserver
nameserver5 String No Fifth nameserver
dnsmanagement Number No Enables dns management for this domain
emailforwarding Number No Enables email forwarding for this domain
idprotection Number No Enables id protection for this domain
firstname String Yes First name of the user
lastname String Yes Last name of the user
address1 String Yes First part of user address
address2 String No Second part of user address
city String Yes City of the user
state String Yes State/Province of the user
postcode String Yes Postal/ZIP Code of the user
country String Yes Country of the user
phonenumber String Yes Phone number in the format +NNN.NNNNNNNNNN
email String Yes Email address of the user
adminfirstname String No First name of the admin user
adminlastname String No Last name of the admin user
adminaddress1 String No First part of admin user address
adminaddress2 String No Second part of admin user address
admincity String No City of the admin user
adminstate String No State/Province of the admin user
adminpostcode String No Postal/ZIP Code of the admin user
admincountry String No Country of the admin user
adminphonenumber String No Phone number in the format +NNN.NNNNNNNNNN
adminemail String No Email address of the admin user
domainfields String No A base64 encoded serialized array of the TLD specific field values
Example Request:
curl 'http://www.domainresellers.co.za/domainsResellerAPI/api.php'
 --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=
test@exampledomain.com&action=TransferDomain&sld=exampledomain
&tld=com&transfersecret=gd23h231s21&regperiod=1
&nameserver1=ns1.yourdomain.com&nameserver2=ns2.yourdomain.com
&firstname=test&lastname=test&companyname=company&address1=
addresss&city=city&state=region&country=US&postcode=12345&phonenumber
=1234567890&email=admin@exampledomain.com' --compressed
Example Response:
{"result":"success","msg":"Domain transfer initiated successfully."}

RenewDomain

This command is used to send a Renew command to the registrar.

Request Parameters
NameTypeRequired?Description
sld String Yes Domain name
tld String Yes Suffix attached to domain name
regperiod Number Yes Registration period
Example Request:
curl 'http://www.domainresellers.co.za/domainsResellerAPI/api.php' 
--data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=
test@exampledomain.com&action=RenewDomain&sld=exampledomain&tld
=com&regperiod=1' --compressed
Example Response:
{"result":"success","msg":"The domain has been successfully."}

GetNameservers

This command is used to obtain the nameservers of a domain.

Request Parameters
NameTypeRequired?Description
sld String Yes Domain name
tld String Yes Suffix attached to domain name
Example Request:
curl 'http://www.domainresellers.co.za/domainsResellerAPI/api.php' 
--data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=
test@exampledomain.com&action=GetNameservers&sld=example
domain&tld=com' --compressed
Example Response:
{"result":"success","ns1":"ns1.exampledomain.com","ns2":"ns2.exampledomain.com"}

SaveNameservers

This command is used to update the nameservers of a domain.

Request Parameters
NameTypeRequired?Description
sld String Yes Domain name
tld String Yes Suffix attached to domain name
nameserver1 String No First nameserver
nameserver2 String No Second nameserver
nameserver3 String No Third nameserver
nameserver4 String No Fourth nameserver
nameserver5 String No Fifth nameserver
Example Request:
curl 'http://www.domainresellers.co.za/domainsResellerAPI/api.php' --data
 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&
action=SaveNameservers&sld=exampledomain&tld=com&
ns1=ns1.exampledomain.com&ns2=ns2.exampledomain.com' --compressed
Example Response:
{"result":"success"}

ReleaseDomain

This command is used to send a Release command to the registrar.

Request Parameters
NameTypeRequired?Description
sld String Yes Domain name
tld String Yes Suffix attached to domain name
newtag String Yes The new tag for the domain
Example Request:
curl 'http://www.domainresellers.co.za/domainsResellerAPI/api.php'
 --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=
test@exampledomain.com&action=ReleaseDomain&sld=exampledomain
&tld=com&newtag=1AND1-TEST' --compressed
Example Response:
{"result":"success"}

RequestDelete

This function is called when a domain is requested to be deleted

Request Parameters
NameTypeRequired?Description
sld String Yes Domain name
tld String Yes Suffix attached to domain name
Example Request:
curl 'http://www.domainresellers.co.za/domainsResellerAPI/api.php' 
--data 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=
test@exampledomain.com&action=RequestDelete&sld=exampledomain&
tld=com' --compressed
Example Response:
{"result":"success"}

GetEPPCode

This command is used to obtain the EPP Code of a domain.

Request Parameters
NameTypeRequired?Description
sld String Yes Domain name
tld String Yes Suffix attached to domain name
Example Request:
curl 'http://www.domainresellers.co.za/domainsResellerAPI/api.php' --data 
'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&
action=GetEPPCode&sld=exampledomain&tld=com' --compressed
Example Response:
{"result":"success","eppcode":"23svxce123fds"}

GetContactDetails

This command is used to perform a whois lookup on a specified domain.

Request Parameters
NameTypeRequired?Description
sld String Yes Domain name
tld String Yes Suffix attached to domain name
Example Request:
curl 'http://www.domainresellers.co.za/domainsResellerAPI/api.php' --data
 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&
action=GetContactDetails&sld=exampledomain&tld=com' --compressed
Example Response:
{"result":"success","Registrant":{"Name":"John Doe","Company":"Company name","Address":"P.O.","City":"Amsterdam",
"Country":"NL","Zip_Code":"1001 GT","Email":"john@exampledomain.com","Telephone":"N\/A"}}

SaveContactDetails

his command is used to update the contact information on a domain.

Request Parameters
NameTypeRequired?Description
sld String Yes Domain name
tld String Yes Suffix attached to domain name
contactdetails Array Yes  
Example Request:
curl 'http://www.domainresellers.co.za/domainsResellerAPI/api.php' --data 
'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&
action=SaveContactDetails&sld=exampledomain&tld=com
&contactdetails[Registrant][Name]=John%20Doe&contactdetails[Registrant][Company]
=Company%20name&contactdetails[Registrant][Address]=Address&contactdetails
[Registrant][City]=Amsterdam&contactdetails[Registrant][Country]=NL&contactdetails
[Registrant][Zip_Code]=1001 GT&contactdetails[Registrant][Email]=test
@exampledomain.com&contactdetails[Registrant][Telephone]=N/A' --compressed
Example Response:
{"result":"success","Registrant":{"Name":"John Doe","Company":"Company name","Address":"P.O.","City":"Amsterdam",
"Country":"NL","Zip_Code":"1001 GT","Email":"john@exampledomain.com","Telephone":"N\/A"}}

DomainGetLockingStatus

This command is used to obtain the lock state of a domain.

Request Parameters
NameTypeRequired?Description
sld String Yes Domain name
tld String Yes Suffix attached to domain name
Example Request:
curl 'http://www.domainresellers.co.za/domainsResellerAPI/api.php' --data 
'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com
&action=domaingetlockingstatus&sld=exampledomain&tld=com' --compressed
Example Response:
{"result":"success","lockstatus":"unlocked"}

DomainUpdateLockingStatus

This command is used to update the lock state of a domain.

Request Parameters
NameTypeRequired?Description
sld String Yes Domain name
tld String Yes Suffix attached to domain name
lockstatus Null/Number No To lock the domain, set it to '1'
Example Request:
curl 'http://www.domainresellers.co.za/domainsResellerAPI/api.php' --data
 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&
action=domainupdatelockingstatus&sld=exampledomain&tld=com&lockstatus=' 
--compressed
Example Response:
{"result":"success"}

GetDNS

This function is called when the DNS Host Records are requested to be viewed within WHMCS Request Parameters
NameTypeRequired?Description
sld String Yes Domain name
tld String Yes Suffix attached to domain name
Example Request:
curl 'http://www.domainresellers.co.za/domainsResellerAPI/api.php' --data 
'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com
&action=GetDNS&sld=exampledomain&tld=com' --compressed
Example Response:
{"0":{"hostname":"*","type":"A","address":"0.0.0.0","priority":null},"1":
{"hostname":"mail","type":"MXE","address":"0.0.0.0","priority":"10"},"result":"success"}

SaveDNS

This function is called when any changes to DNS Host Records information is submitted Request Parameters
NameTypeRequired?Description
sld String Yes Domain name
tld String Yes Suffix attached to domain name
dnsrecords String Yes A base64 encoded serialized array of the dns records.
base64_encode(serialize(array(0=>array("hostname"=>"*","type"=>"A","address"=>"0.0.0.0","priority"=>"N/A","recid"=>""))));;
Example Request:
curl 'http://www.domainresellers.co.za/domainsResellerAPI/api.php' --data
 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&
action=SaveDNS&sld=exampledomain&tld=com&dnsrecords=czowOiIiOw==' --compressed
Example Response:
{"result":"success"}

RegisterNameserver

This function is called when a child nameserver is requested to be registered Request Parameters
NameTypeRequired?Description
sld String Yes Domain name
tld String Yes Suffix attached to domain name
nameserver String Yes  
ipaddress String Yes  
Example Request:
curl 'http://www.domainresellers.co.za/domainsResellerAPI/api.php' --data 
'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&
action=RegisterNameserver&sld=exampledomain&tld=com&nameserver=
test.exampledomain.com&ipaddress=1.1.1.1' --compressed
Example Response:
{"result":"success"}

ModifyNameserver

This function is called when a child nameserver is requested to be edited Request Parameters
NameTypeRequired?Description
sld String Yes Domain name
tld String Yes Suffix attached to domain name
nameserver   String Yes  
currentipaddress String Yes  
newipaddress String Yes  
Example Request:
curl 'http://www.domainresellers.co.za/domainsResellerAPI/api.php' --data
 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com
&action=ModifyNameserver&sld=exampledomain&tld=com&
nameserver=test.exampledomain.com&currentipaddress=1.1.1.1&
newipaddress=2.2.2.2' --compressed
Example Response:
{"result":"success"}

DeleteNameserver

This function is called when a child nameserver is requested to be deleted Request Parameters
NameTypeRequired?Description
sld String Yes Domain name
tld String Yes Suffix attached to domain name
nameserver String Yes  
Example Request:
curl 'http://www.domainresellers.co.za/domainsResellerAPI/api.php' --data
 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&
action=DeleteNameserver&sld=exampledomain&tld=com&
nameserver=test.exampledomain.com' --compressed
Example Response:
{"result":"success"}

GetEmailForwarding

This function is called when the Email Forwarding are requested to be viewed within WHMCS Request Parameters
NameTypeRequired?Description
sld String Yes Domain name
tld String Yes Suffix attached to domain name
Example Request:
curl 'http://www.domainresellers.co.za/domainsResellerAPI/api.php' --data
 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&
action=GetEmailForwarding&sld=exampledomain&tld=com' --compressed
Example Response:
{"1":{"prefix":"test","forwardto":"test@exampledomain.com"},"result":"success"}

SaveEmailForwarding

This function is called when the Email Forwarding are requested to be viewed within WHMCS Request Parameters
NameTypeRequired?Description
sld String Yes Domain name
tld String Yes Suffix attached to domain name
prefix String Yes A base64 encoded serialized array of the prefixes.
base64_encode(serialize(array(0=>"test"))));
forwardto String Yes A base64 encoded serialized array of the forwards.
base64_encode(serialize(array(0=>"test@exampledomain.com")));
Example Request:
curl 'http://www.domainresellers.co.za/domainsResellerAPI/api.php' --data
 'token=AaLc8eNZWsZtWlT9LtT7NUha&authemail=test@exampledomain.com&
action=SaveEmailForwarding&sld=exampledomain&tld=com&prefix=czowOiIiOw=
=&forwardto=czowOiIiOw==' --compressed
Example Response:
{"result":"success"}


Was this answer helpful?

Add to Favourites Add to Favourites    Print this Article Print this Article

Also Read
API Introduction (Views: 1864)
Example Code (PHP) (Views: 2047)

Powered by WHMCompleteSolution

Domains

Domain Search

Website Hosting

Contact

Copyright © 2015 Domain Resellers. All rights reserved.