API Actions Print

  • 36

RegisterDomain:

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

Request Parameters
NameTypeRequired?Description
sldStringYesDomain name
tldStringYesSuffix attached to domain name
regperiodNumberYesRegistration period
nameserver1StringNoFirst nameserver
nameserver2StringNoSecond nameserver
nameserver3StringNoThird nameserver
nameserver4StringNoFourth nameserver
nameserver5StringNoFifth nameserver
adminfirstnameStringYesFirst name of the admin user
adminlastnameStringYesLast name of the admin user
adminaddress1StringYesFirst part of admin user address
adminaddress2StringNoSecond part of admin user address
admincityStringYesCity of the admin user
adminstateStringYesState/Province of the admin user
adminpostcodeStringYesPostal/ZIP Code of the admin user
admincountryStringYesCountry of the admin user
adminphonenumberStringYesPhone number in the format +NNN.NNNNNNNNNN
adminemailStringYesEmail address of the admin user
dnsmanagementNumberNoEnables dns management for this domain
emailforwardingNumberNoEnables email forwarding for this domain
idprotectionNumberNoEnables id protection for this domain
Example Request:
curl 'http://www.fidonet.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&email=test@exampledomain.com&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&adminemail=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
sldStringYesDomain name
tldStringYesSuffix attached to domain name
transfersecretStringNoDomain authorization code
regperiodNumberYesRegistration period
nameserver1StringYesFirst nameserver
nameserver2StringYesSecond nameserver
nameserver3StringNoThird nameserver
nameserver4StringNoFourth nameserver
nameserver5StringNoFifth nameserver
adminfirstnameStringYesFirst name of the admin user
adminlastnameStringYesLast name of the admin user
adminaddress1StringYesFirst part of admin user address
adminaddress2StringNoSecond part of admin user address
admincityStringYesCity of the admin user
adminstateStringYesState/Province of the admin user
adminpostcodeStringYesPostal/ZIP Code of the admin user
admincountryStringYesCountry of the admin user
adminphonenumberStringYesPhone number in the format +NNN.NNNNNNNNNN
adminemailStringYesEmail address of the admin user
dnsmanagementNumberNoEnables dns management for this domain
emailforwardingNumberNoEnables email forwarding for this domain
idprotectionNumberNoEnables id protection for this domain
Example Request:
curl 'http://www.fidonet.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&email=test@exampledomain.com&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&adminemail=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
sldStringYesDomain name
tldStringYesSuffix attached to domain name
regperiodNumberYesRegistration period
Example Request:
curl 'http://www.fidonet.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&email=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
sldStringYesDomain name
tldStringYesSuffix attached to domain name
Example Request:
curl 'http://www.fidonet.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&email=test@exampledomain.com&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
sldStringYesDomain name
tldStringYesSuffix attached to domain name
nameserver1StringYesFirst nameserver
nameserver2StringYesSecond nameserver
nameserver3StringNoThird nameserver
nameserver4StringNoFourth nameserver
nameserver5StringNoFifth nameserver
Example Request:
curl 'http://www.fidonet.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&email=test@exampledomain.com&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
sldStringYesDomain name
tldStringYesSuffix attached to domain name
newtagStringYesThe new tag for the domain
Example Request:
curl 'http://www.fidonet.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&email=test@exampledomain.com&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
sldStringYesDomain name
tldStringYesSuffix attached to domain name
Example Request:
curl 'http://www.fidonet.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&email=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
sldStringYesDomain name
tldStringYesSuffix attached to domain name
Example Request:
curl 'http://www.fidonet.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&email=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
sldStringYesDomain name
tldStringYesSuffix attached to domain name
contactdetailsArrayYes
Example Request:
curl 'http://www.fidonet.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&email=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
sldStringYesDomain name
tldStringYesSuffix attached to domain name
Example Request:
curl 'http://www.fidonet.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&email=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
sldStringYesDomain name
tldStringYesSuffix attached to domain name
lockstatusNull/NumberNoTo lock the domain, set it to '1'
Example Request:
curl 'http://www.fidonet.com/domainsResellerAPI/api.php' --data 'token=AaLc8eNZWsZtWlT9LtT7NUha&email=test@exampledomain.com&action=domainupdatelockingstatus&sld=exampledomain&tld=com&lockstatus=' --compressed
Example Response:
{"result":"success"}


Was this answer helpful?

« Back