Session handling

To start an EPP Gateway session, the client must send a “login” command using valid credentials. An EPP Gateway session is closed by sending a “logout” command or simply by closing the TCP connection. After an initial greeting, clients can always query the Gateway by sending a “hello” command.

Hello command

An EPP client MAY request a from the EPP server at any time. Often this command is used for checking the status of the EPP server.

Request

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<epp
    xmlns="urn:ietf:params:xml:ns:epp-1.0">
    <hello></hello>
</epp>

Response

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
  <greeting>
    <svID>ST Registry EPP server epp-api.sandbox.registry.st</svID>
    <svDate>2014-06-19T14:46:07+02:00</svDate>
    <svcMenu>
      <version>1.0</version>
      <lang>en</lang>
      <objURI>urn:ietf:params:xml:ns:domain-1.0</objURI>
      <objURI>urn:ietf:params:xml:ns:contact-1.0</objURI>
      <objURI>urn:ietf:params:xml:ns:host-1.0</objURI>
      <svcExtension>
        <extURI>urn:ietf:params:xml:ns:domainsCollection-1.0</extURI>
        <extURI>urn:ietf:params:xml:ns:whoisPrivacy-1.0</extURI>
        <extURI>urn:ietf:params:xml:ns:registrar-1.0</extURI>
      </svcExtension>
    </svcMenu>
    <dcp>
      <access>
        <all></all>
      </access>
      <statement>
        <purpose>
          <admin></admin>
          <prov></prov>
        </purpose>
        <recipient>
          <ours></ours>
          <public></public>
        </recipient>
        <retention>
          <stated></stated>
        </retention>
      </statement>
    </dcp>
  </greeting>
</epp>

Login command

An EPP Gateway session must be established before any operations can be sent to the gateway. Additionally, EPP limits login ID to a maximum of 16 characters.

Request

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<epp
    xmlns="urn:ietf:params:xml:ns:epp-1.0">
    <command>
        <login>
            <clID>login</clID>
            <pw>password</pw>
        </login>
        <clTRID>53a2dc350dec6</clTRID>
    </command>
</epp>

Response

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
  <response>
    <result code="1000">
      <msg>Command completed successfully</msg>
    </result>
    <trID>
      <clTRID>53a2dc350dec6</clTRID>
      <svTRID>e802eec5-67bc-492b-90c0-ec2a4adf90af</svTRID>
    </trID>
  </response>
</epp>

Logout command

An EPP Gateway session in general should be must closed with the “Logout” command after all instructions are complete, unless for performance reasons you wish to keep the connection open. Please remember that the connection is automatically closed when the TCP timeout occurs or the TCP session is closed.

Request

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<epp
    xmlns="urn:ietf:params:xml:ns:epp-1.0">
    <command>
        <logout></logout>
        <clTRID>53a2e02c46ddd</clTRID>
    </command>
</epp>

Response

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
  <response>
    <result code="1500">
      <msg>Command completed successfully; ending session</msg>
    </result>
    <trID>
      <clTRID>53a2e02c46ddd</clTRID>
      <svTRID>53a2e4cb46bf9</svTRID>
    </trID>
  </response>
</epp>