EPP integration specification for Estonian Internet Foundation
Introduction
Introduction text here
Basics
Login
| Field name |
Required |
Attributes |
Field description |
| login |
true |
|
|
| clTRID |
false |
|
Client transaction id |
login
| Field name |
Required |
Field description |
| clID |
true |
Username |
| pw |
true |
Password |
| options |
false |
|
| svcs |
false |
|
options
| Field name |
Required |
Field description |
| version |
false |
1.0 |
| lang |
false |
en |
svcs
| Field name |
Required |
Field description |
| objURI |
false |
Object URI that is going to be used in current connection. (0-n) |
| svcExtension |
false |
|
svcExtension
| Field name |
Required |
Field description |
| extURI |
false |
Extension URI that is going to be used in current connection. (0-n) |
Domain related functions
Domain create
| Field name |
Required |
Attributes |
Field description |
| create |
true |
|
|
| extension |
true |
|
|
| clTRID |
false |
|
Client transaction id |
create
| Field name |
Required |
Attributes |
Field description |
| domain:create |
true |
xmlns:domain (urn:ietf:params:xml:ns:domain-1.0) |
|
domain:create
| Field name |
Required |
Attributes |
Field description |
| domain:name |
true |
|
Domain name. Can contain unicode characters. |
| domain:period |
false |
unit (y, m, d) |
Registration period for domain. Must add up to 1 / 2 / 3 years. |
| domain:ns |
true |
|
Nameserver listing (2-11) |
| domain:registrant |
true |
|
Contact reference to the registrant |
| domain:contact |
true if registrant is a juridical person |
type (admin) |
Contact reference |
| domain:contact |
false |
type (tech, admin) |
Contact reference (0-n) |
domain:ns
domain:hostAttr
| Field name |
Required |
Attributes |
Field description |
| domain:hostName |
true |
|
Hostname of the nameserver |
| domain:hostAddr |
true if nameserver is under domain zone |
ip (v4, v6) |
(0-n) |
extension
| Field name |
Required |
Attributes |
Field description |
| secDNS:create |
false |
|
DNSSEC details |
| eis:extdata |
true |
xmlns:eis (urn:ee:eis:xml:epp:eis-1.0) |
Legal document |
secDNS:create
| Field name |
Required |
Attributes |
Field description |
| secDNS:keyData |
true |
xmlns:secDNS (urn:ietf:params:xml:ns:secDNS-1.1) |
DNSSEC key data |
secDNS:keyData
| Field name |
Required |
Attributes |
Field description |
| secDNS:flags |
true |
|
Allowed values: 0, 256, 257 |
| secDNS:protocol |
true |
|
Allowed values: 3 |
| secDNS:alg |
true |
|
Allowed values: 3, 5, 6, 7, 8, 252, 253, 254, 255 |
| secDNS:pubKey |
true |
|
Public key |
eis:extdata
| Field name |
Required |
Attributes |
Field description |
| eis:legalDocument |
true |
type (pdf) |
Base64 encoded document |
EXAMPLE REQUEST AND RESPONSE
Domain update
| Field name |
Required |
Attributes |
Field description |
| update |
true |
|
|
| extension |
true if registrant is changing |
|
|
| clTRID |
false |
|
Client transaction id |
update
| Field name |
Required |
Attributes |
Field description |
| domain:update |
true |
xmlns:domain (urn:ietf:params:xml:ns:domain-1.0) |
|
domain:update
| Field name |
Required |
Attributes |
Field description |
| domain:name |
true |
|
Domain name. Can contain unicode characters. |
| domain:chg |
false |
|
Attributes to change |
| domain:add |
false |
|
Objects to add |
| domain:rem |
false |
|
Objects to remove |
domain:chg
| Field name |
Required |
Attributes |
Field description |
| domain:registrant |
false |
|
Contact reference to the registrant |
domain:add
| Field name |
Required |
Attributes |
Field description |
| domain:ns |
false |
|
Nameservers TODO: Get rid of hostObj |
| domain:contact |
false |
type (tech, admin) |
Contact reference (0-n) |
| domain:status |
false |
s (clientDeleteProhibited, clientHold, clientRenewProhibited, clientTransferProhibited, clientUpdateProhibited) |
Status description (may be left empty) (0-n) |
domain:rem
| Field name |
Required |
Attributes |
Field description |
| domain:ns |
false |
|
Nameservers TODO: Get rid of hostObj |
| domain:contact |
false |
type (tech, admin) |
Contact reference (0-n) |
| domain:status |
false |
s (clientDeleteProhibited, clientHold, clientRenewProhibited, clientTransferProhibited, clientUpdateProhibited) |
Status description (may be left empty) (0-n) |
extension
| Field name |
Required |
Attributes |
Field description |
| secDNS:create |
false |
|
DNSSEC details TODO: MAYBE THIS SHOULD BE secDNS:update ? |
| eis:extdata |
true if registrant is changing |
xmlns:eis (urn:ee:eis:xml:epp:eis-1.0) |
Legal document |
secDNS:create TODO: secDNS:update??
| Field name |
Required |
Attributes |
Field description |
| secDNS:add |
false |
|
Objects to add |
| secDNS:rem |
false |
|
Objects to remove |
secDNS:add
| Field name |
Required |
Attributes |
Field description |
| secDNS:keyData |
true |
xmlns:secDNS (urn:ietf:params:xml:ns:secDNS-1.1) |
DNSSEC key data (0-n) |
secDNS:rem
| Field name |
Required |
Attributes |
Field description |
| secDNS:keyData |
true |
xmlns:secDNS (urn:ietf:params:xml:ns:secDNS-1.1) |
DNSSEC key data (0-n) |
EXAMPLE REQUEST AND RESPONSE
Domain delete
| Field name |
Required |
Attributes |
Field description |
| delete |
true |
|
|
| extension |
true |
|
|
| clTRID |
false |
|
Client transaction id |
delete
| Field name |
Required |
Attributes |
Field description |
| domain:delete |
true |
xmlns:domain (urn:ietf:params:xml:ns:domain-1.0) |
|
domain:delete
| Field name |
Required |
Attributes |
Field description |
| domain:name |
true |
|
Domain name. Can contain unicode characters. |
extension
| Field name |
Required |
Attributes |
Field description |
| eis:extdata |
true |
xmlns:eis (urn:ee:eis:xml:epp:eis-1.0) |
Legal document |
EXAMPLE REQUEST AND RESPONSE
Domain info
| Field name |
Required |
Attributes |
Field description |
| info |
true |
|
|
| extension |
false |
|
|
| clTRID |
false |
|
Client transaction id |
info
| Field name |
Required |
Attributes |
Field description |
| domain:info |
true |
xmlns:domain (urn:ietf:params:xml:ns:domain-1.0) |
|
domain:info
| Field name |
Required |
Attributes |
Field description |
| domain:name |
true |
hosts (all, TODO) |
Domain name. Can contain unicode characters. |
| domain:authInfo |
false |
|
Domain password |
domain:authinfo
| Field name |
Required |
Attributes |
Field description |
| domain:pw |
true |
roid (String) TODO: find out why we need roid |
Domain password |
extension
| Field name |
Required |
Attributes |
Field description |
| eis:extdata |
false |
xmlns:eis (urn:ee:eis:xml:epp:eis-1.0) |
Legal document |
EXAMPLE REQUEST AND RESPONSE
Domain renew
| Field name |
Required |
Attributes |
Field description |
| renew |
true |
|
|
| extension |
false |
|
|
| clTRID |
false |
|
Client transaction id |
renew
| Field name |
Required |
Attributes |
Field description |
| domain:renew |
true |
xmlns:domain (urn:ietf:params:xml:ns:domain-1.0) |
|
domain:renew
| Field name |
Required |
Attributes |
Field description |
| domain:name |
true |
|
Domain name. Can contain unicode characters. |
| domain:curExpDate |
true |
|
Current expiry date (ISO8601 format) |
| domain:period |
true |
unit (y, m, d) |
Renew period, must add up to 1, 2 or 3 years. |
EXAMPLE REQUEST AND RESPONSE
Domain transfer
| Field name |
Required |
Attributes |
Field description |
| transfer |
true |
op (approve, query, reject) |
|
| extension |
false |
|
|
| clTRID |
false |
|
Client transaction id |
transfer
| Field name |
Required |
Attributes |
Field description |
| domain:transfer |
true |
xmlns:domain (urn:ietf:params:xml:ns:domain-1.0) |
|
domain:transfer
| Field name |
Required |
Attributes |
Field description |
| domain:name |
true |
|
Domain name. Can contain unicode characters. |
| domain:authInfo |
true |
|
Domain password |
EXAMPLE REQUEST AND RESPONSE
Domain check
| Field name |
Required |
Attributes |
Field description |
| check |
true |
|
|
| extension |
false |
|
|
| clTRID |
false |
|
Client transaction id |
check
| Field name |
Required |
Attributes |
Field description |
| domain:check |
true |
xmlns:domain (urn:ietf:params:xml:ns:domain-1.0) |
|
domain:transfer
| Field name |
Required |
Attributes |
Field description |
| domain:name |
true |
|
Domain name. Can contain unicode characters. |
EXAMPLE REQUEST AND RESPONSE
