Metaregistrar EPP documentation

All domain commands: (check) (create) (delete) (info) (modify) (transfer) (renew) (undelete) (privacy) (autorenew)

Checking a Domain

To create ,modify or retrieve domain information you need to use a domain command. These use the urn:ietf:params:xml:ns:domain-1.0 namespace with prefix domain



Basics in checking a domain

You check a domain by sending a check->domain:check command. You can supply the domain-names in their utf-8 format. For more information about IDN domains please check the Repository of IDN Practices page over at IANA.

In this example we are checking icanhascheeseburger.frl and the icanhascheeseburger.eu domain for availability.

Example domain:check

<?xml version="1.0" encoding="UTF-8"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <command> <check> <domain:check> <domain:name>docu-test-case.nl</domain:name> </domain:check> </check> <clTRID>57cff5b3750b3</clTRID> </command> </epp>

Example domain:check response

<?xml version="1.0" encoding="UTF-8"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <response> <result code="1000"> <msg>Command completed successfully</msg> </result> <resData> <domain:chkData> <domain:cd> <domain:name avail="true">docu-test-case.nl</domain:name> </domain:cd> </domain:chkData> </resData> <trID> <svTRID>MTR_ffbe414d2285cc8a2c5b8fabd98f491be9552743</svTRID> <clTRID>57cff5b3750b3</clTRID> </trID> </response> </epp> The above result (avail:true) indicates that the domain name is not registered and thus available for registration. You can proceed with registering the domain name.

If an avail:false result is returned, the extra info domain:reason will tell you why the domain name is not available for registration. That might be because the domain name is already registered, but the name might also be reserved by the registry, or there might be another cause. Multiple domain:reason fields might be returned in various languages, but almost all registries use english only.

<?xml version="1.0" encoding="UTF-8"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <response> <result code="1000"> <msg>Command completed successfully</msg> </result> <resData> <domain:chkData> <domain:cd> <domain:name avail="false">docu-test-case.nl</domain:name> <domain:reason lang="en">Domain is in use.</domain:reason> </domain:cd> </domain:chkData> </resData> <trID> <svTRID>MTR_fcb6a26e4e33e32d3ca876d96cc6eadf01f03686</svTRID> <clTRID>57cff6916e865</clTRID> </trID> </response> </epp>



Checking IDN domains

You can also check for IDN domainnames. Try this for example. <?xml version="1.0" encoding="UTF-8"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <command> <check> <domain:check> <domain:name>icanhaschëëseburger.frl</domain:name> </domain:check> </check> </command> </epp>

And you will get this response <?xml version="1.0" encoding="UTF-8"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" xmlns:contact="urn:ietf:params:xml:ns:contact-1.0" xmlns:host="urn:ietf:params:xml:ns:host-1.0" xmlns:ext="http://www.metaregistrar.com/epp/ext-1.0" xmlns:secDNS="urn:ietf:params:xml:ns:secDNS-1.1"> <response> <result code="1000"> <msg>Command completed successfully</msg> </result> <resData> <domain:chkData> <domain:cd> <domain:name avail="true">icanhaschëëseburger.frl</domain:name> </domain:cd> </domain:chkData> </resData> <trID> <svTRID>MTR-testhash</svTRID> </trID> </response> </epp>

Unsupported characters

If you supply bad characters to this: for example try to this with cyrilic characters on .frl

<?xml version="1.0" encoding="UTF-8"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"> <command> <check> <domain:check> <domain:name>я-могу-иметь-чизбургер.frl</domain:name> </domain:check> </check> </command> </epp>

You will receive avail="false" and the reason will be "invalid" <?xml version="1.0" encoding="UTF-8"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:domain="urn:ietf:params:xml:ns:domain-1.0" xmlns:contact="urn:ietf:params:xml:ns:contact-1.0" xmlns:host="urn:ietf:params:xml:ns:host-1.0" xmlns:ext="http://www.metaregistrar.com/epp/ext-1.0" xmlns:secDNS="urn:ietf:params:xml:ns:secDNS-1.1"> <response> <result code="1000"> <msg>Command completed successfully</msg> </result> <resData> <domain:chkData> <domain:cd> <domain:name avail="false">я-могу-иметь-чизбургер.frl</domain:name> <domain:reason lang="en">invalid</domain:reason> </domain:cd> </domain:chkData> </resData> <trID> <svTRID>MTR-testhash</svTRID> </trID> </response> </epp>