Moniker API Integration Guide
Moniker API Reference
Overview
The moniker API is divided into the following functional areas.
Account Management
· Get Account Balance · Get Account Info
Domain Management
· Domain Availability Check · Domain Info · Domain Registration · Domain Delete · Domain Update · Domain Searching
Contact Management
· Contact Info · Contact Update · Contact Add · Contact Retrieve · Contact List
Name Server Management
· Name Server Info · Name Server Update · Name Server Add · Name Server Delete
Transfer Out Management
· Set Domain transfer Code · Lock/Unlock a Domain · Transfer Acknowledgement
Transaction Management
· Transaction Summary History · Transaction Detail History
Zone Management
· Zone Info · Zone Record Update · Zone Record Add · Zone Record Delete
IP Restriction
For all requests you are required to supply your Moniker account ID and password to identify yourself to our system. We also require that you supply an IP address from which you will be making requests - these will be matched against your Moniker account to uniquely identify your transactions.
Further, requests beyond searches and availability checks will require that you communicate with our servers on a secure (https) protocol. We will also require your password via the "password" parameter. Please note that your password will not be visible to anyone as the https protocol encrypts the entire request.
If authentication fails for any request the status will be a "3xx" error. <?xml version="1.0" encoding="UTF-8"?>
<MonikerTransaction> ...
<status code="302" serveref="23213232">
<message>
IP Authentication Failure
</message>
</status>
</MonikerTransaction>
Role Restriction
Some partners are allowed to execute out transfer management API. Your request will receive a 303 error if you don’t have access.
<?xml version="1.0" encoding="UTF-8"?>
<MonikerTransaction> ...
<status code="303" serveref="23213232">
<message>
Role Authorization Error
</message>
</status>
</MonikerTransaction> XML API Response Codes
The Moniker API has the following "Response Codes". Success is defined as status code of 200. Response Codes Success Codes
200 Success
Authentication Error Codes
301 User Credentials Failure
302 IP Authentication Failure
303 Role Authorization Failure
Request Error Codes
401 Missing Required Parameters
402 Invalid Parameter
403 Action Not Implemented
Response Error Codes
501 Domain Not Found in your account
502 Domain Not Pending transfer
503 Registry Error
504 Unsupported TLD
505 Invalid Domain Name
506 Domain Unavailable
507 Domain Delete Failure
508 All Domains Unavailable
509 Domain Registration Failure
510 Domain Operation Failure
601 Name Server Management Failure
602 Contact Management Failure
603 Zone Management Failure
801 System Failure
802 Insufficient Account Funds
TRANSFER MANAGEMENT API
We allow you to set a domains transfer code, lock or unlock the domain, Acknowledge or NACK the domain transfer request.
Set Domain Transfer Code
The following parameters are required for setting a domain transfer code. cmd - Must be "domainauth" account - Valid Moniker account ID password - valid Moniker account password domain - Valid domain in the Moniker account domainauth - Any valid 16 characters client-ref - Optional client reference information, for auditing purposes only
Example Request: http://api.moniker.com/pub/ExternalApi?cmd=domainauth&account=1000&password=mypassword&domain=moniker.com&domainauth=eppcode&client-ref=myrefnumber
Response: <MonikerTransaction> <status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
domainauth
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="domain">
moniker.com
</parameter>
<parameter name="domainauth">
eppcode
</parameter>
</request> <response password="eppcode">
moniker.com
</response> </MonikerTransaction>
Lock a Domain
The following parameters are required for locking or unlocking a domain. cmd - Must be "domainlock" account - Valid Moniker account ID password - valid Moniker account password domain - Valid domain in the Moniker account lock - Set to 1 to lock or 0 to unlock client-ref - Optional client reference information, for auditing purposes only
Example Request: http://api.moniker.com/pub/ExternalApi?cmd=domainlock&account=1000&password=mypassword&domain=moniker.com&lock=1&client-ref=myrefnumber
Response: <MonikerTransaction>
<status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
domainlock
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="domain">
moniker.com
</parameter>
<parameter name="lock"> 1
</parameter>
</request>
<response lock="1" oldlockstatus="unlocked" newlockstatus="locked"> moniker.com </response>
</MonikerTransaction>
Domain Transfer Acknowledgement
The following parameters are required to Ack or Nack a domain transfer. Set the ack parameter to 1 to ack a domain transfer cmd - Must be "transferack" account - Valid Moniker account ID password - valid Moniker account password domain - Valid domain in the Moniker account ack - Set to 1 to Ack or 0 to Nack client-ref - Optional client reference information, for auditing purposes only
Example Request: http://api.moniker.com/pub/ExternalApi?cmd=transferack&account=1000&password=mypassword&domain=moniker.com&ack=1&client-ref=myrefnumber
Response: <MonikerTransaction> <status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
transferack
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="domain">
moniker.com
</parameter>
<parameter name="ack">
1
</parameter>
</request>
<response ack="1">
moniker.com
</response>
</MonikerTransaction>
ACCOUNT MANAGEMENT API
We allow you to get all your account demographics as well as your Moniker Balance.
Get Account Information
The following parameters are required for getting your account information which includes your account balance cmd - Must be "accountinfo" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only
Example Request: http://api.moniker.com/pub/ExternalApi?cmd=accountinfo&account=1000&password=mypassword&client-ref=myrefnumber
Response: <MonikerTransaction> <status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
accountinfo
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
</request>
</MonikerTransaction>
DOMAIN MANAGEMENT API
We allow you to perform the following functions up to 500 domains per request. You can get the domain attributes. If you are tasting domains you can delete domains within the 4 day grace period. You can register and update domains as well.
The domain searching API allows you 4 ways to search for domains. You can get a list of expiring domains as well as the domains that are pending delete. We allow you to see what domains are in a specific category. Of course you can get a list of all your domains.
Check Domain Availability
The following parameters are required for getting your account information which includes your account balance cmd - Must be "domaincheck" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only domains – List of domain comma separated.
Example Request: http://api.moniker.com/pub/ExternalApi?cmd=domaincheck&account=1000&password=mypassword&client-ref=myrefnumber&domains=testdomain.com,testdomain2.com
Response: <MonikerTransaction> <status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
accountinfo
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="domain">
Testdomain.com
</parameter>
<parameter name="domain">
Testdomain2.com
</parameter>
</request>
</MonikerTransaction>
Get Domain Information
The following parameters are required for getting a domains information which includes name servers, contacts, expiration date and other domain attributes. Contacts for admin, tech, billing and registrant returns the ID of those contacts. You can use another API request to obtain the contact details. cmd - Must be "domaininfo" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only domain – Domain Name.
Example Request: http://api.moniker.com/pub/ExternalApi?cmd=domaininfo&account=1000&password=mypassword&client-ref=myrefnumber&domain=testdomain.com
Response: <MonikerTransaction> <status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
domaininfo
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="domain">
Testdomain.com
</parameter>
</request>
<response> <domain admin="10674" registrant="10674" billing="10674" tech="10674" ns1="NS3.MONIKER.COM" ns2="NS4.MONIKER.COM" ns3="" ns4="" ns5="" ns6="" renew_auto="0" renew_years="0" lock_status="0" date_created="2006-02-17 14:09:59.847" date_updated="2006-02-17 14:09:59.847" date_expired="2007-02-17 00:00:00.0" category="apitest6">APITEST6-2-71.COM</domain> </response>
</MonikerTransaction>
Domain Delete
The following parameters are required for deleting a list of domains that are in the 4 day grace period. cmd - Must be "domaindelete" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only domains – List of domains comma separated.
Example Request: http://api.moniker.com/pub/ExternalApi?cmd=domaindelete&account=1000&password=mypassword&client-ref=myrefnumber&domains=testdomain.com,testdomain2.com
Response: <MonikerTransaction>
<status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
domaindelete
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="domain">
Testdomain.com
</parameter>
<parameter name="domain">
Testdomain2.com
</parameter>
</request>
<response> <domain code=200 msg="success">testdomain.com</domain> <domain code=507 msg="Domain Already Deleted">testdomain2.com</domain>
</response>
</MonikerTransaction>
Register Domains
The following parameters are required for registering domains You must supply all the parameters below and the contacts and name servers must already exist. cmd - Must be "domainregister" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only Agree – Do you agree to our Terms and Conditions if so Set to yes or request will fail Admin_NIC – The admin contact ID Bill_NIC – The Billing contact ID Tech_NIC – The Tech contact ID Reg_NIC – The registrant contact ID Primary_NS – The Primary name Server Secondary_NS – The secondary name Server domains – List of domains you want to register separated by a semicolon. You must also specify the # of years you want to register the domain for. See example below for the syntax
domains=test.com:1;test2.com:1
The following parameters are optional and if not specified will default to the accounts domain preferences
Tertiary_NS – The Tertiary name Server Quaternary_NS – The Quaternary name Server Quintenary_NS – The Quintenary name Server Sextenary_NS – The Sextenary name Server Auto_Renew_Req – Yes to auto renew all domains otherwise No to decline Lock_Req – Yes to Lock all domains otherwise No to decline Renew_Years – # of years to renew domains whe auto renew was requested Category – Category of all the domains being registered
Response: <MonikerTransaction>
<status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
domainregister
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="domain">
Test1.com
</parameter>
<parameter name="domain">
Test2.com
</parameter>
</request>
<response> <domain code=200 msg="success">testdomain.com</domain> <domain code=509 msg="Domain Registration Failure”>testdomain2.com</domain>
</response>
</MonikerTransaction>
Domain Searching
Use this API to get a list of domains based on a specified action. You can get a list of domains that are expiring in “n” days. Use the category action to get a list of domain in that category. You can also get a list of domains that are pending deletion and have already expired. You can also get your entire list of domains. cmd - Must be "domainsearch" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only action – specify one of the following (category, all, expire, pendingdelete)
Parameters that depend on the action specified
category – specify the domain category only if action is “category” days – The # of days until domain expiration. Specify this parameter if action is “expire”
Example Category Request: http://api.moniker.com/pub/ExternalApi?cmd=domainsearch&account=1000&password=mypassword&client-ref=myrefnumber&action=category&category=adultnames
Response: <MonikerTransaction>
<status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
domainsearch
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="action">
category
</parameter>
<parameter name="category">
adultnames
</parameter>
</request>
<response> <domain admin="10674" registrant="10674" billing="10674" tech="10674" ns1="NS3.MONIKER.COM" ns2="NS4.MONIKER.COM" ns3="" ns4="" ns5="" ns6="" renew_auto="0" renew_years="0" lock_status="0" date_created="2006-02-17 14:09:59.847" date_updated="2006-02-17 14:09:59.847" date_expired="2007-02-17 00:00:00.0" category="adultnames">sexy.com</domain>
<domain admin="10674" registrant="10674" billing="10674" tech="10674" ns1="NS3.MONIKER.COM" ns2="NS4.MONIKER.COM" ns3="" ns4="" ns5="" ns6="" renew_auto="0" renew_years="0" lock_status="0" date_created="2006-02-17 14:09:59.847" date_updated="2006-02-17 14:09:59.847" date_expired="2007-02-17 00:00:00.0" category="adultnames">sexyone.com</domain>
</response>
</MonikerTransaction>
Example Expired Domains Request: http://api.moniker.com/pub/ExternalApi?cmd=domainsearch&account=1000&password=mypassword&client-ref=myrefnumber&action=expire&days=30
Response: <MonikerTransaction> <status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
domainsearch
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="action">
expire
</parameter>
<parameter name="days">
30
</parameter>
</request>
<response> <domain admin="10674" registrant="10674" billing="10674" tech="10674" ns1="NS3.MONIKER.COM" ns2="NS4.MONIKER.COM" ns3="" ns4="" ns5="" ns6="" renew_auto="0" renew_years="0" lock_status="0" date_created="2006-02-17 14:09:59.847" date_updated="2006-02-17 14:09:59.847" date_expired="2007-02-17 00:00:00.0" category="adultnames">sexy.com</domain>
<domain admin="10674" registrant="10674" billing="10674" tech="10674" ns1="NS3.MONIKER.COM" ns2="NS4.MONIKER.COM" ns3="" ns4="" ns5="" ns6="" renew_auto="0" renew_years="0" lock_status="0" date_created="2006-02-17 14:09:59.847" date_updated="2006-02-17 14:09:59.847" date_expired="2007-02-17 00:00:00.0" category="adultnames">sexyone.com</domain>
</response>
</MonikerTransaction>
Example Domains Pending Delete Request: http://api.moniker.com/pub/ExternalApi?cmd=domainsearch&account=1000&password=mypassword&client-ref=myrefnumber&action=pendingdelete
Response: <MonikerTransaction> <status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
domainsearch
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="action">
pendingdelete
</parameter>
</request>
<response> <domain admin="10674" registrant="10674" billing="10674" tech="10674" ns1="NS3.MONIKER.COM" ns2="NS4.MONIKER.COM" ns3="" ns4="" ns5="" ns6="" renew_auto="0" renew_years="0" lock_status="0" date_created="2006-02-17 14:09:59.847" date_updated="2006-02-17 14:09:59.847" date_expired="2007-02-17 00:00:00.0" category="adultnames">sexy.com</domain>
<domain admin="10674" registrant="10674" billing="10674" tech="10674" ns1="NS3.MONIKER.COM" ns2="NS4.MONIKER.COM" ns3="" ns4="" ns5="" ns6="" renew_auto="0" renew_years="0" lock_status="0" date_created="2006-02-17 14:09:59.847" date_updated="2006-02-17 14:09:59.847" date_expired="2007-02-17 00:00:00.0" category="adultnames">sexyone.com</domain>
</response>
</MonikerTransaction>
Domain Update
The following parameters are for updating domains data. You aren’t required to supply all the parameters below. Contact ID’S and Name server must exist must exist prior cmd - Must be "domainregister" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only domains – List of domains you want to modify separated by a semicolon.
The following parameters are optional and if not specified will default to the accounts domain preferences
Admin_NIC – The admin contact ID Bill_NIC – The Billing contact ID Tech_NIC – The Tech contact ID Reg_NIC – The registrant contact ID Primary_NS – The Primary name Server Secondary_NS – The secondary name Server Tertiary_NS – The Tertiary name Server Quaternary_NS – The Quaternary name Server Quintenary_NS – The Quintenary name Server Sextenary_NS – The Sextenary name Server Auto_Renew_Req – Yes to auto renew all domains otherwise No to decline Lock_Req – Yes to Lock all domains otherwise No to decline Renew_Years – # of years to renew domains whe auto renew was requested Category – Category of all the domains being registered
Response: <MonikerTransaction>
<status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
domainupdate
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="domain">
Test1.com
</parameter>
<parameter name="domain">
Test2.com
</parameter>
</request>
<response> <domain code=200 msg="success">test1.com</domain> <domain code=510 msg="Domain Update Failure”>test2.com</domain>
</response>
</MonikerTransaction>
NAME SERVER MANAGEMENT API
We allow you to perform the following functions up to a maximum 500 name servers per request. You can get the IP address and change the IP address of a given name server that you own. We also allow you to delete name servers.
Get Name Server Information
The following parameters are required for getting the IP address of a list of Name Servers. cmd - Must be "nameserverinfo" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only nameservers – List of name servers separated by commas.
Response: <MonikerTransaction> <status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
nameserverinfo
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="nameserver">
ns1.testdomain.com
</parameter>
<parameter name="nameserver">
ns2.testdomain.com
</parameter>
</request>
<response> <nameserver code=200 msg="success">ns1.testdomain.com</nameserver> <nameserver code=601 msg="Name Server dose not exist”>ns2.testdomain.com</nameserver>
</response>
</MonikerTransaction>
Add Name Servers
The following parameters are required for adding a list of Name Servers for a domain you own. cmd - Must be "nameserveradd" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only nameservers – List of name servers and their IP separated by semi-colons.
Note: Separate the IP address from the host name with a comma nameservers=ns1.testdomain.com,203.12.23.34;ns2.testdomain.com,203.12.23.35
Response: <MonikerTransaction>
<status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
nameserveradd
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="nameserver" ip=”203.12.23.34”>
ns1.testdomain.com
</parameter>
<parameter name="nameserver" ip=”203.12.23.35”>
ns2.testdomain.com
</parameter>
</request>
<response> <nameserver code=200 msg="success" ip=”203.12.23.34”>ns1.testdomain.com</nameserver> <nameserver code=601 msg="Name Server does not exist” ip=”203.12.23.35” >ns2.testdomain.com</nameserver>
</response>
</MonikerTransaction>
Update Name Servers
The following parameters are required for updating the IP address of a list of Name Servers. cmd - Must be "nameserverupdate" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only nameservers – List of name servers and their IP separated by semi-colons.
Note: Separate the IP address from the host name with a comma
nameservers=ns1.testdomain.com,203.12.23.34;ns2.testdomain.com,203.12.23.35
Response: <MonikerTransaction> <status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
nameserverupdate
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="nameserver" ip=”203.12.23.34”>
ns1.testdomain.com
</parameter>
<parameter name="nameserver" ip=”203.12.23.35”>
ns2.testdomain.com
</parameter>
</request>
<response> <nameserver code=200 msg="success" ip=”203.12.23.34”>ns1.testdomain.com</nameserver> <nameserver code=601 msg="Name Server dose not exist” ip=”203.12.23.35” >ns2.testdomain.com</nameserver>
</response>
</MonikerTransaction>
Delete Name Servers
The following parameters are required for deleting multiple name servers. cmd - Must be "nameserverinfo" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only nameservers – List of name servers separated by commas.
Response: <MonikerTransaction> <status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
nameserverdelete
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="nameserver">
ns1.testdomain.com
</parameter>
<parameter name="nameserver">
ns2.testdomain.com
</parameter>
</request>
<response> <nameserver code=200 msg="success">ns1.testdomain.com</nameserver> <nameserver code=601 msg="Name Server does not exist”>ns2.testdomain.com</nameserver>
</response>
</MonikerTransaction>
Get Contact Information By ID
The following parameters are required for getting contact data. You can provide a list of contact ID’S or just and individual one. cmd - Must be "contactlist" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only id – List of contact ID’S separated by comas.
Example Request: http://api.moniker.com/pub/ExternalApi?cmd=contactlist&account=1000&password=mypassword&client-ref=myrefnumber&email=12234,124566
Response: <MonikerTransaction> <status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
contactlist
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="id">
122345
</parameter>
</request>
<response> <contact code=200 msg="success" id=122345 fname=john lname=doe company=johndoe,inc address1=20 sw 27th address2=suite 201 city=pompano state=fl zip=33069 country=US phone=561-350-5652 fax=561-350-5653 datecreated=10/27/2007 dateupdated=01/2/2008 email=jinghem@moniker.com>122345</contact>
</response>
</MonikerTransaction>
Get Contact Information By Email
The following parameters are required for getting a list of contacts information by specified email address cmd - Must be "contactinfo" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only email – List of contact email addresses separated by comas.
Example Request: http://api.moniker.com/pub/ExternalApi?cmd=contactinfo&account=1000&password=mypassword&client-ref=myrefnumber&email=jinghem@moniker.com
Response: <MonikerTransaction> <status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
contactinfo
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="email>
jinghem@moniker.com
</parameter>
</request>
<response> <contact code=200 msg="success" id=122345 fname=john lname=doe company=johndoe,inc address1=20 sw 27th address2=suite 201 city=pompano state=fl zip=33069 country=US phone=561-350-5652 fax=561-350-5653 datecreated=10/27/2007 dateupdated=01/2/2008>jinghem@moniker.com</contact>
</response>
</MonikerTransaction>
Get All Contacts
The following parameters are required for getting a list of all contacts for your account cmd - Must be "contactretrieve" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only
Example Request: http://api.moniker.com/pub/ExternalApi?cmd=contactretrieve&account=1000&password=mypassword&client-ref=myrefnumber
Response: <MonikerTransaction>
<status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
contactretrieve
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="contactlist">
All contacts
</parameter>
</request>
<response> <contact code=200 msg="success" id=122345 fname=john lname=doe company=johndoe,inc address1=20 sw 27th address2=suite 201 city=pompano state=fl zip=33069 country=US phone=561-350-5652 fax=561-350-5653 datecreated=10/27/2007 dateupdated=01/2/2008>jinghem@moniker.com</contact>
<contact code=200 msg="success" id=122346 fname=john lname=doe company=johndoe,inc address1=20 sw 27th address2=suite 201 city=pompano state=fl zip=33069 country=US phone=561-350-5652 fax=561-350-5653 datecreated=10/22/2007 dateupdated=01/3/2008>jinghem@moniker.com</contact>
</response>
</MonikerTransaction>
Add A Contact
The following parameters are required for adding a contact. The contact ID will be returned in the results response element. cmd - Must be "contactadd" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only Firstname – First name Lastname – Last name Email – Email Address Company – Company Name Address1 – contact Address Address2 – Unit address City – City State – state Zip – postal code Country – country Phone – phone # without country prefix Fax – Fax without country code prefix
Response: <MonikerTransaction> <status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
contactadd
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="id">
123455
</parameter>
<parameter name="firstname">
John
</parameter>
<parameter name="lastname">
Doe
</parameter>
<parameter name="email">
Johndoe@moniker.com
</parameter>
<parameter name="company">
JohnDoe,INC
</parameter>
<parameter name="address1">
20th sw 27th ave
</parameter>
<parameter name="address2">
Suite 201
</parameter>
<parameter name="city">
Pompano beach
</parameter>
<parameter name="state">
Florida
</parameter>
<parameter name="zip">
33498
</parameter>
<parameter name="country">
US
</parameter>
<parameter name="phone">
5613454567
</parameter>
<parameter name="fax">
5612344567
</parameter>
</request>
<response> <contact code=200 msg="success" >123457</contact>
</response>
</MonikerTransaction>
Update a Contact
The following parameters are required for updating a contact. The contact ID is required to identify the contact we are updating. cmd - Must be "contactupdate" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only ID – ID of the contact to update
The following parameters are optional depending on what you are trying to update
Firstname – First name Lastname – Last name Email – Email Address Company – Company Name Address1 – contact Address Address2 – Unit address City – City State – state Zip – postal code Country – country Phone – phone # without country prefix Fax – Fax without country code prefix
Response: <MonikerTransaction> <status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
contactupdate
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="id">
123455
</parameter>
<parameter name="firstname">
John
</parameter>
<parameter name="lastname">
Doe
</parameter>
<parameter name="email">
Johndoe@moniker.com
</parameter>
<parameter name="company">
JohnDoe,INC
</parameter>
<parameter name="address1">
20th sw 27th ave
</parameter>
<parameter name="address2">
Suite 201
</parameter>
<parameter name="city">
Pompano beach
</parameter>
<parameter name="state">
Florida
</parameter>
<parameter name="zip">
33498
</parameter>
<parameter name="country">
US
</parameter>
<parameter name="phone">
5613454567
</parameter>
<parameter name="fax">
5612344567
</parameter>
</request>
<response> <contact code=200 msg="success" >123457</contact>
</response>
</MonikerTransaction>
Get Transactions (Summary Version)
The following parameters are required for getting a list of your transactions without details. Transaction types are as follows I – Invoice P – Payment V- Void C -Credit
cmd - Must be "trxsummary" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only
Example Request: http://api.moniker.com/pub/ExternalApi?cmd=trxsummary&account=1000&password=mypassword&client-ref=myrefnumber
Response: <MonikerTransaction>
<status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
trxsummary
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="type">
Transaction summary
</parameter>
</request>
<response> <trx id=122345 trxdate=10/27/2007 trxtype=I trxamt=100.00 trxpaymethod=Visa>1342455</trx> <trx id=122346 trxdate=10/27/2007 trxtype=P trxamt=100.00 trxpaymethod=Visa>1342456</trx> <trx id=122347 trxdate=10/29/2007 trxtype=I trxamt=100.00 trxpaymethod=Visa>1342457</trx>
</response>
Get Transactions (Detail Version)
The following parameters are required for getting a list of your transactions without details. Transaction types are as follows I – Invoice P – Payment V- Void
cmd - Must be "trxdetail" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only
Example Request: http://api.moniker.com/pub/ExternalApi?cmd=trxdetail&account=1000&password=mypassword&client-ref=myrefnumber
Response: <MonikerTransaction> <status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
trxdetail
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="type">
Transaction Detail
</parameter>
</request>
<response> <trx trxdate=10/27/2007 trxtype=I trxdesc=Register Domain Name trxqty=1 trxprice=10.00 trxapplied=123567>1342455</trx> <trx trxdate=10/27/2007 trxtype=P trxdesc=Register Domain Name trxqty=1 trxprice=10.00 trxapplied=123567>1342455</trx>
</response>
Zone MANAGEMENT API
We allow you to perform the following functions on domains in your account. You can get the zone records for a given domain. We also allow you to add, delete and update records in the zone. This means you can manage the following record types (A, MX, CNAME, TXT) You will need the zone record ID below in red to manage an individual zone record
<zonerecord host="@" data="208.73.210.50" type="A" priority="0">915988</zonerecord>
Get Zone Records
The following parameters are required for getting the contents of a given zone.
cmd - Must be "zoneinfo" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only zone – List of zones(Domains) existing in your account separated by commas.
Example Request:
Response:
<MonikerTransaction> <status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
zoneinfo
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="zone">
Mydomain1.com
</parameter>
<parameter name="zone">
Mydomain2.com
</parameter>
</request>
<response>
<zone code="200" msg="success" updated="2009-09-10 06:14:13 PM" ttl="21600" c created="2009-09-10 01:50:01 PM">
Mydomain1.com <zonerecord host="@" data="208.73.210.50" type="A" priority="0">915988</zonerecord> <zonerecord host="*" data="208.73.210.50" type="A" priority="0">915989</zonerecord> <zonerecord host="www" data="208.73.210.50" type="A" priority="0">915994</zonerecord>
</zone>
<zone code="200" msg="success" updated="2009-09-10 06:14:13 PM" ttl="21600" c created="2009-09-10 01:50:01 PM">
Mydomain2.com <zonerecord host="@" data="208.73.210.50" type="A" priority="0">915988</zonerecord> <zonerecord host="*" data="208.73.210.50" type="A" priority="0">915989</zonerecord> <zonerecord host="www" data="208.73.210.50" type="A" priority="0">915994</zonerecord>
</zone>
</response>
<status code="200" serveref="582269">
<message>Success</message> </status>
</MonikerTransaction>
Add Zone Record
The following parameters are required for adding a list of Name Servers for a domain you own.
cmd - Must be "zonerecordadd" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only zone – Zone Domain name to add record to type – record types (A,NX,TXT,CNAME) host – valid host data for specified record type data – valid data for specified record type
Request:
Response:
<MonikerTransaction>
<status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
zonerecordadd
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="zone"> mytestdomain.com </parameter>
<parameter name="type">A</parameter> <parameter name="host">test</parameter> <parameter name="data">207.12.12.34</parameter>
</request>
<response>
<domain> mytestdomain.com </domain>
</response>
<status code="200" serveref="582269">
<message>Success</message> </status>
</MonikerTransaction>
Update Zone record
The following parameters are required for updating a specific zone record.
cmd - Must be "zoneupdaterecord" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only zone – Zone to update (Domain name) id – Zone record ID to update (gotten from the zone info command) type – Zone Record Type (A, MX, CNAME, TXT)
Request:
Response:
<MonikerTransaction> <status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
zonerecordupdate
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="zone"> mytestdomain.com </parameter>
<parameter name="id">915994</parameter>
<parameter name="type">A</parameter>
<parameter name="host">newhost</parameter>
</request>
<response>
<domain> mytestdomain.com </domain>
</response>
<status code="200" serveref="582269">
<message>Success</message> </status>
</MonikerTransaction>
Delete Zone Record
The following parameters are required for deleting an existing zone record.
cmd - Must be "zonerecorddelete" account - Valid Moniker account ID password - valid Moniker account password client-ref - Optional client reference information, for auditing purposes only zone – Zone to update (Domain name) id – Zone record ID to delete (gotten from the zone info command)
Request:
Response: <MonikerTransaction> <status code="200" serveref="23213232">
<message>
Success
</message>
</status>
<request code="200" serveref="23213232">
<action>
zonerecorddelete
</action>
<ip>
127.0.0.1
</ip>
<client-ref>
1467894f
</client-ref>
<parameter name="zone"> mytestdomain.com </parameter> <parameter name="id">915994</parameter>
</request>
<response>
<domain> mytestdomain.com </domain>
</response>
<status code="200" serveref="582269">
<message>Success</message> </status>
</MonikerTransaction>
Web Hosting Wiki article text shared under a Creative Commons License.
