EPP API

1. Domain collections

To simplify domain portfolio management for each registrar – ST Registry has implemented “Domains collection” extension. Extension is supposed to simplify synchronisation between Registrar local database and Registry repository.

1.1 Info

Purpose for the “Info” command is to simplify querying domains collection by “walking” through it partially. Info command return number of domains in Registrar portfolio.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<epp

xmlns="urn:ietf:params:xml:ns:epp-1.0">

<domainsCollection:domainsCollection

xmlns:domainsCollection="urn:ietf:params:xml:ns:domainsCollection-1.0">

<domainsCollection:info></domainsCollection:info>

</domainsCollection:domainsCollection>

</extension>

</epp>

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<msg>Command completed successfully</msg>

</result>

<domainsCollection:infData xmlns:domainsCollection="urn:ietf:params:xml:ns:domainsCollection-1.0">

<domainsCollection:count>3000</domainsCollection:count>

</domainsCollection:infData>

</resData>

<trID>

</trID>

</response>

</epp>

1.2 Query

Query command for DomainCollection extension provide possibility to query Registrar domains partially from its collection.

Request should contain 2 attributes:

limit – identify how many domains we are querying
offset – position from which we are querying domains. Collection count start from 0 (zero) position, this mean that first domain in collection have position 0 (zero)

In example request below we are querying 2 domains with position #101 and #102 in our collection:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<epp

xmlns="urn:ietf:params:xml:ns:epp-1.0">

<domainsCollection:domainsCollection

xmlns:domainsCollection="urn:ietf:params:xml:ns:domainsCollection-1.0">

<domainsCollection:query limit="2" offset="100"></domainsCollection:query>

</domainsCollection:domainsCollection>

</extension>

</epp>

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<msg>Command completed successfully</msg>

</result>

<domainsCollection:queData xmlns:domainsCollection="urn:ietf:params:xml:ns:domainsCollection-1.0">

<domainsCollection:info>

<domainsCollection:count>2</domainsCollection:count>

<domainsCollection:total>3</domainsCollection:total>

<domainsCollection:limit>2</domainsCollection:limit>

<domainsCollection:offset>1</domainsCollection:offset>

</domainsCollection:info>

<domainsCollection:domains>

<domainsCollection:domain>example1.st</domainsCollection:domain>

<domainsCollection:domain>example2.st</domainsCollection:domain>

</domainsCollection:domains>

</domainsCollection:queData>

</resData>

<trID>

</trID>

</response>

</epp>

2. Registrar info

Registrar info extension provide possibility to fetch current registrar details in ST Registry system.

Response on request below will provide information:

Registrar general details
Registrar contacts (administrative, technical and billing)
Billing plan details including balance, date since billing plan was assigned and billing rates.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<epp

xmlns="urn:ietf:params:xml:ns:epp-1.0">

<registrar:registrar

xmlns:registrar="urn:ietf:params:xml:ns:registrar-1.0">

<registrar:info></registrar:info>

</registrar:registrar>

</extension>

</epp>

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<msg>Command completed successfully</msg>

</result>

<registrar:infData xmlns:registrar="urn:ietf:params:xml:ns:registrar-1.0">

<registrar:clID>ABC123456XYZ</registrar:clID>

<registrar:organization>Client organization</registrar:organization>

<registrar:publicName>Client public name</registrar:publicName>

<registrar:country>US</registrar:country>

<registrar:address>Some street</registrar:address>

<registrar:url>websiteurl.st</registrar:url>

<registrar:whois>whois.nic.st</registrar:whois>

<registrar:contact type="admin">ABC111</registrar:contact>

<registrar:contact type="tech">ABC112</registrar:contact>

<registrar:contact type="billings">ABC113</registrar:contact>

<registrar:billingPlan>

<registrar:name since="2013-10-08T00:00:00+00:00">LEVEL1</registrar:name>

<registrar:records>

<registrar:record name="Balance">0</registrar:record>

<registrar:record name="BillingPeriod">12</registrar:record>

<registrar:record name="ClientState">ACTIVE</registrar:record>

<registrar:record name="ContactCreatePrice">0</registrar:record>

<registrar:record name="ContactDeletePrice">0</registrar:record>

<registrar:record name="ContactUpdatePrice">0</registrar:record>

<registrar:record name="CreditLimit">0</registrar:record>

<registrar:record name="Currency">EUR</registrar:record>

<registrar:record name="DomainCreatePrice">2</registrar:record>

<registrar:record name="DomainDeletePrice">0</registrar:record>

<registrar:record name="DomainRenewPrice">2</registrar:record>

<registrar:record name="DomainTransferFee">0</registrar:record>

<registrar:record name="DomainUpdatePrice">0</registrar:record>

<registrar:record name="HostCreatePrice">0</registrar:record>

<registrar:record name="HostDeletePrice">0</registrar:record>

<registrar:record name="HostUpdatePrice">0</registrar:record>

<registrar:record name="IDNDomainCreatePrice">0</registrar:record>

<registrar:record name="IDNDomainRenewPrice">0</registrar:record>

<registrar:record name="MaxBillingPeriod">5</registrar:record>

<registrar:record name="MinBillingPeriod">1</registrar:record>

<registrar:record name="OneLetterDomainCreateFee">2500</registrar:record>

<registrar:record name="OneLetterDomainCreatePrice">2</registrar:record>

<registrar:record name="OneLetterDomainRenewFee">0</registrar:record>

<registrar:record name="OneLetterDomainRenewPrice">2</registrar:record>

<registrar:record name="RedemptionFee">0</registrar:record>

<registrar:record name="Status">normal</registrar:record>

<registrar:record name="TwoLetterDomainCreateFee">999</registrar:record>

<registrar:record name="TwoLetterDomainCreatePrice">2</registrar:record>

<registrar:record name="TwoLetterDomainRenewFee">0</registrar:record>

<registrar:record name="TwoLetterDomainRenewPrice">2</registrar:record>

<registrar:record name="VAT">0</registrar:record>

</registrar:records>

</registrar:billingPlan>

</registrar:infData>

</resData>

<trID>

</trID>

</response>

</epp>

3. Whois privacy

ST Registry require accurate contact details for every registered domain, this information is used in case a dispute arises about the domain name.This information is often displayed in the WHOIS system which is public and can be viewed by anyone. WHOIS Privacy extension should be used if registrant would like to hide domain contact information from a public view partialy or completely. This function is totally free of charge for every accredited ST Registrar. In other words – WHOIS privacy is used to “mask”/hide domain contact(s) with another contact or set of contacts defined by the current sponsoring domain registrar. Its up to the Registrar if he should use same privacy contact for all contacts and for all domains or if every domain should have own privacy contact or set of contacts.

Since complete domain details can be fetched only by sponsoring registar while other registrar(s) are able to do it only through WHOIS info command (or request(s) to ST Registry WHOIS public servers), this mean that all regisrars except sponsoring registrar will be able to see only privacy contact details if such contact(s) was defined for domain using Whois privacy command.

WHOIS public servers respond identical domain details to WHOIS query command.

Example for Domain info command response for domain with privacy contacts:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<msg>Command completed successfully</msg>

</result>

<domain:infData xmlns:domain="urn:ietf:params:xml:ns:domain-1.0">

<domain:name>example.st</domain:name>

<domain:status s="ok"></domain:status>

<domain:registrant>ABC111</domain:registrant>

<domain:contact type="admin_privacy">PRIVACY222</domain:contact>

<domain:contact type="billing_privacy">PRIVACY333</domain:contact>

<domain:contact type="tech_privacy">PRIVACY444</domain:contact>

<domain:contact type="admin">ABC222</domain:contact>

<domain:contact type="billing">ABC333</domain:contact>

<domain:contact type="tech">ABC444</domain:contact>

<domain:contact type="registrant_privacy">PRIVACY111</domain:contact>

<domain:ns>

<domain:hostObj>ns1.host.st</domain:hostObj>

<domain:hostObj>ns2.host.st</domain:hostObj>

</domain:ns>

<domain:clID>CliendID1</domain:clID>

<domain:crID>ClientID1</domain:crID>

<domain:crDate>2014-01-01T00:00:01+00:00</domain:crDate>

<domain:exDate>2015-01-01T00:00:01+00:00</domain:exDate>

<domain:upID>ClientID1</domain:upID>

<domain:upDate>2014-01-02T06:38:03+00:00</domain:upDate>

<domain:authInfo>

<domain:pw>D0ma1nAuthCode</domain:pw>

</domain:authInfo>

</domain:infData>

</resData>

<trID>

</trID>

</response>

</epp>

3.1 Create

Command create privacy contact for one or more contact(s) (in this example we assign privacy contacts for all 4 contacts: registrant, admin, billing and tech contacts):

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<epp

xmlns="urn:ietf:params:xml:ns:epp-1.0">

<whoisPrivacy:whoisPrivacy

xmlns:whoisPrivacy="urn:ietf:params:xml:ns:whoisPrivacy-1.0">

<whoisPrivacy:create>

<whoisPrivacy:domain>example.st</whoisPrivacy:domain>

<whoisPrivacy:contact type="registrant">PRIVACY111</whoisPrivacy:contact>

<whoisPrivacy:contact type="admin">PRIVACY222</whoisPrivacy:contact>

<whoisPrivacy:contact type="tech">PRIVACY333</whoisPrivacy:contact>

<whoisPrivacy:contact type="billing">PRIVACY444</whoisPrivacy:contact>

</whoisPrivacy:create>

</whoisPrivacy:whoisPrivacy>

</extension>

</epp>

Successful response:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<msg>Command completed successfully</msg>

</result>

<trID>

</trID>

</response>

</epp>

3.2 Update

Command update privacy contact for one or more contact(s):

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<epp

xmlns="urn:ietf:params:xml:ns:epp-1.0">

<whoisPrivacy:whoisPrivacy

xmlns:whoisPrivacy="urn:ietf:params:xml:ns:whoisPrivacy-1.0">

<whoisPrivacy:update>

<whoisPrivacy:domain>example.st</whoisPrivacy:domain>

<whoisPrivacy:contact type="admin">PRIVACY111</whoisPrivacy:contact>

</whoisPrivacy:update>

</whoisPrivacy:whoisPrivacy>

</extension>

</epp>

Successful response:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<msg>Command completed successfully</msg>

</result>

<trID>

</trID>

</response>

</epp>

3.3 Delete

Command delete remove all privacy contacts from corresponding domain.

Delete command request example:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<epp

xmlns="urn:ietf:params:xml:ns:epp-1.0">

<whoisPrivacy:whoisPrivacy

xmlns:whoisPrivacy="urn:ietf:params:xml:ns:whoisPrivacy-1.0">

<whoisPrivacy:remove>

<whoisPrivacy:domain>example.st</whoisPrivacy:domain>

</whoisPrivacy:remove>

</whoisPrivacy:whoisPrivacy>

</extension>

</epp>

Successful response:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<msg>Command completed successfully</msg>

</result>

<trID>

</trID>

</response>

</epp>

4. Whois info query

ST Registry has developed Whois info extension for EPP Gateway to simplify domains management by accredited registrars.

Domain details fetched with Whois info command is completely identical to one that is retrieved from ST Registry WHOIS public servers.

Request example:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<epp

xmlns="urn:ietf:params:xml:ns:epp-1.0">

<whois:whois

xmlns:whois="urn:ietf:params:xml:ns:whois-1.0">

<whois:query>example.st</whois:query>

</whois:whois>

</extension>

</epp>

Successful response:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<msg>Command completed successfully</msg>

</result>

<whois:queryData xmlns:whois="urn:ietf:params:xml:ns:whois-1.0">

<whois:name>example.st</whois:name>

<whois:registrarName>ST Registry accredited registrar</whois:registrarName>

<whois:registrarUrl>accreditedregistrar.st</whois:registrarUrl>

<whois:crDate>2014-01-01T00:00:01+00:00</whois:crDate>

<whois:exDate>2015-09-11T00:00:01+00:00</whois:exDate>

<whois:upDate>2014-01-12T15:41:55+00:00</whois:upDate>

<whois:status s="ok"></whois:status>

<whois:contactInfo type="registrant">

<whois:id>PRIVACY111</whois:id>

<whois:name>Privact contact name</whois:name>

<whois:organization></whois:organization>

<whois:street></whois:street>

<whois:city></whois:city>

<whois:state></whois:state>

<whois:zip></whois:zip>

<whois:country>ST</whois:country>

<whois:phone>+1.1234567890</whois:phone>

<whois:fax></whois:fax>

<whois:email>private@contact.st</whois:email>

</whois:contactInfo>

<whois:contactInfo type="admin">

<whois:id>ABC222</whois:id>

<whois:name>Public contact name</whois:name>

<whois:organization></whois:organization>

<whois:street></whois:street>

<whois:city></whois:city>

<whois:state></whois:state>

<whois:zip></whois:zip>

<whois:country>ST</whois:country>

<whois:phone>+1.0987654321</whois:phone>

<whois:fax></whois:fax>

<whois:email>get@domain.st</whois:email>

</whois:contactInfo>

<whois:contactInfo type="tech">

<whois:id>ABC222</whois:id>

<whois:name>Public contact name</whois:name>

<whois:organization></whois:organization>

<whois:street></whois:street>

<whois:city></whois:city>

<whois:state></whois:state>

<whois:zip></whois:zip>

<whois:country>ST</whois:country>

<whois:phone>+1.0987654321</whois:phone>

<whois:fax></whois:fax>

<whois:email>get@domain.st</whois:email>

</whois:contactInfo>

<whois:contactInfo type="billing">

<whois:id>ABC222</whois:id>

<whois:name>Public contact name</whois:name>

<whois:organization></whois:organization>

<whois:street></whois:street>

<whois:city></whois:city>

<whois:state></whois:state>

<whois:zip></whois:zip>

<whois:country>ST</whois:country>

<whois:phone>+1.0987654321</whois:phone>

<whois:fax></whois:fax>

<whois:email>get@domain.st</whois:email>

</whois:contactInfo>

<whois:ns>

<whois:hostObj>ns1.host.st</whois:hostObj>

<whois:hostObj>ns2.host.st</whois:hostObj>

</whois:ns>

</whois:queryData>

</resData>

<trID>

</trID>

</response>

</epp>

Response example if requested domain not found:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<msg>Domain object does not exists</msg>

</result>

<trID>

</trID>

</response>

</epp>

ST Registry

Knowledge Base

Extensions

1. Domain collections

1.1 Info

1.2 Query

2. Registrar info

3. Whois privacy

3.1 Create

3.2 Update

3.3 Delete

4. Whois info query

Message polling

Host management

Contact management

Domain management

Session handling

Transport

EPP over TCP

Introduction into EPP