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 Yes First nameserver
nameserver2 String Yes Second nameserver
nameserver3 String No Third nameserver
nameserver4 String No Fourth nameserver
nameserver5 String No Fifth nameserver
adminfirstname String Yes First name of the admin user
adminlastname String Yes Last name of the admin user
adminaddress1 String Yes First part of admin user address
adminaddress2 String No Second part of admin user address
admincity String Yes City of the admin user
adminstate String Yes State/Province of the admin user
adminpostcode String Yes Postal/ZIP Code of the admin user
admincountry String Yes Country of the admin user
adminphonenumber String Yes Phone number in the format +NNN.NNNNNNNNNN
adminemail String Yes Email address of the admin user
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

Example Request:

curl 'https://vservs.com/clients/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=RegisterDomain&sld=exampledomain&tld=com&regperiod=1&nameserver1=ns1.yourdomain.com&nameserver2=ns2.yourdomain.com&adminfirstname=test&adminlastname=test&admincompanyname=company&adminaddress1=addresss&admincity=city&adminstate=region&admincountry=US&adminpostcode=12345&adminphonenumber=1234567890&[email protected]' --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 Yes First nameserver
nameserver2 String Yes Second nameserver
nameserver3 String No Third nameserver
nameserver4 String No Fourth nameserver
nameserver5 String No Fifth nameserver
adminfirstname String Yes First name of the admin user
adminlastname String Yes Last name of the admin user
adminaddress1 String Yes First part of admin user address
adminaddress2 String No Second part of admin user address
admincity String Yes City of the admin user
adminstate String Yes State/Province of the admin user
adminpostcode String Yes Postal/ZIP Code of the admin user
admincountry String Yes Country of the admin user
adminphonenumber String Yes Phone number in the format +NNN.NNNNNNNNNN
adminemail String Yes Email address of the admin user
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

Example Request:

curl 'https://vservs.com/clients/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=TransferDomain&sld=exampledomain&tld=com&transfersecret=gd23h231s21&regperiod=1&nameserver1=ns1.yourdomain.com&nameserver2=ns2.yourdomain.com&adminfirstname=test&adminlastname=test&admincompanyname=company&adminaddress1=addresss&admincity=city&adminstate=region&admincountry=US&adminpostcode=12345&adminphonenumber=1234567890&[email protected]' --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 'https://vservs.com/clients/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&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 'https://vservs.com/clients/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=GetNameservers&sld=exampledomain&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 Yes First nameserver
nameserver2 String Yes Second nameserver
nameserver3 String No Third nameserver
nameserver4 String No Fourth nameserver
nameserver5 String No Fifth nameserver

Example Request:

curl 'https://vservs.com/clients/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=SaveNameservers&sld=exampledomain&tld=com&ns1=ns1.exampledomain.com&ns2=ns2.exampledomain.com' --compressed

Example Response:

{"result":"success"}

 

RelaseDomain

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 'https://vservs.com/clients/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=RelaseDomain&sld=exampledomain&tld=com&newtag=1AND1-TEST' --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 'https://vservs.com/clients/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&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 'https://vservs.com/clients/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&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":"[email protected]","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 'https://vservs.com/clients/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&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][email protected]&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":"[email protected]","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 'https://vservs.com/clients/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&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 'https://vservs.com/clients/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&[email protected]&action=domainupdatelockingstatus&sld=exampledomain&tld=com&lockstatus=' --compressed

Example Response:

{"result":"success"}
 
  • 0 gebruikers vonden dit artikel nuttig
Was dit antwoord nuttig?

Related Articles

Example Code (PHP)

<?php $data = array( "action" => "RegisterDomain", "sld" =>...

API Introduction

API IntroductionThe Domains Reseller API allows you to interact with our system programmatically...

Vservs B.V. Domain API for WHMCS - Version 2

How to install Vservs API into youre WHMCS:   Upload the files to you`e WHMCS ftp folder...