Nominet

Home Registrants Registrars Governance .uk Policy Disputes/Legal News About Us Intelligence Technology ENUM Other Services

Skip All Secondary and Tertiary Navigation

Become a Registrar Registrar Agreement Fees Renewals Registrar Systems DNSSEC Reseller Data Anti-abuse Registrar Resources Working Groups FAQ

Home › Registrars › Registrar Systems › Nominet EPP › ~ List

Print this page | Contact Us

List command

A domain list operation can be requested by enclosing a <domain:list> element within an <info> command.

<domain:list> element

The <domain:list> element contains the following sub-elements:

Either:

a <domain:month> element giving the registration month to list domain names for

a <domain:expiry> element giving the expiry month to list domain names for

Plus:

An optional <domain:fields> element identifying which fields are to be returned in the response. This may either be "none" (default), where a list of domain names only is returned, or "all", where a list of domain:infData elements are returned.

Example domain list request

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
  <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0
    epp-1.0.xsd">
    <command>
      <info>
        <domain:list 
          xmlns:domain="http://www.nominet.org.uk/epp/xml/nom-domain-2.0"
          xsi:schemaLocation="http://www.nominet.org.uk/epp/xml/nom-domain-2.0
          nom-domain-2.0.xsd">
          <domain:month>2008-12</domain:month>
          <domain:fields>none</domain:fields>
        </domain:list>
      </info>
      <clTRID>ABC-12345</clTRID>
    </command>
  </epp>

Example domain list response

The following shows an example domain list response where <domain:fields> was set to "none":

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0
      epp-1.0.xsd">
   <response>
    <result code="1000">
     <msg>Command completed successfully</msg>
    </result>
    <resData>
     <domain:listData
      xmlns:domain="http://www.nominet.org.uk/epp/xml/nom-domain-2.0"
      xsi:schemaLocation="http://www.nominet.org.uk/epp/xml/nom-domain-2.0
      nom-domain-2.0.xsd"
      no-domains="6">
      <domain:name>epp-example1.co.uk</domain:name>
      <domain:name>epp-example2.co.uk</domain:name>
      <domain:name>epp-example3.co.uk</domain:name>
      <domain:name>epp-example4.co.uk</domain:name>
      <domain:name>epp-example5.co.uk</domain:name>
      <domain:name>epp-example6.co.uk</domain:name>
     </domain:listData>
    </resData>
    <trID>
      <clTRID>EPP-ABC-12345</clTRID>
      <svTRID>54322-XYZ</svTRID>
    </trID>
   </response>
  </epp>

If the <domain:fields> is set to "all", the response will instead contain a list of <domain:infData> elements, as returned by the Info command.

Note that this is potentially a lot of data, and may take some time to return.

The following is an example of a list response that contains no domains:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0
      epp-1.0.xsd">
   <response>
    <result code="1000">
     <msg>Command completed successfully</msg>
    </result>
    <resData>
     <domain:listData
      xmlns:domain="http://www.nominet.org.uk/epp/xml/nom-domain-2.0"
      xsi:schemaLocation="http://www.nominet.org.uk/epp/xml/nom-domain-2.0
      nom-domain-2.0.xsd"
      no-domains="0"/>
    </resData>
    <trID>
      <clTRID>EPP-ABC-12345</clTRID>
      <svTRID>54322-XYZ</svTRID>
    </trID>
   </response>
  </epp>