EPP Server Interface
EPP Data Format Guide
Version 1.31cn
Table of Contents
1
INTRODUCTION 1
2
SESSION COMMANDS 1
2.1
L
OGIN
1
2.2
L
OGOUT
3
2.3
H
ELLO
4
3
DOMAIN COMMANDS 5
3.1
D
OMAIN
C
HECK
5
3.2
D
OMAIN
I
NFO
8
3.3
D
OMAIN
C
REATE
12
3.4
D
OMAIN
D
ELETE
15
3.5
D
OMAIN
R
ENEW
16
3.6
D
OMAIN
C
HANGE
R
EGISTRANT
18
3.7
D
OMAIN
C
HANGE
C
ONTACT
20
3.8
D
OMAIN
A
DD
N
AMESERVERS
22
3.9
D
OMAIN
R
EMOVE
N
AMESERVERS
24
4
HOST COMMANDS 26
4.1
H
OST
C
HECK
26
4.2
H
OST
I
NFO
28
4.3
H
OST
C
REATE
31
4.4
H
OST
D
ELETE
33
4.5
H
OST
U
PDATE
IP 34
5
CONTACT COMMANDS 36
5.1
C
ONTACT
I
NFO
36
5.2
C
ONTACT
C
REATE
42
5.3
C
ONTACT
D
ELETE
48
5.4
C
ONTACT
U
PDATE
49
1
1 Introduction
The EPP server will receive EPP XML documents based on the format that is
documented herein.
The typical corresponding reply to each command is also provided herein.
2 Session Commands
2.1 Login
Client:
Field
Name/Format
Description Required(R)/
Optional(O)
REGISTRARID Registrar Login ID (Provided by the
Registry)
R
PASSWORD Password of REGISTRARID R
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
<command>
<login>
<clID>REGISTRARID </clID>
<pw>PASSWORD</pw>
<options>
<version>1.0</version>
<lang>en</lang>
</options>
<svcs>
<objURI>urn:ietf:params:xml:ns:obj1</objURI>
<objURI>urn:ietf:params:xml:ns:obj2</objURI>
<objURI>urn:ietf:params:xml:ns:obj3</objURI>
</svcs>
</login>
<clTRID>987654321</clTRID>
</command>
</epp>
2
Example:
Server:
<?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>987654321</clTRID>
<svTRID>54321-XYZ</svTRID>
</trID>
</response>
</epp>
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
<command>
<login>
<clID>registrarabc</clID>
<pw>password</pw>
<options>
<version>1.0</version>
<lang>en</lang>
</options>
<svcs>
<objURI>urn:ietf:params:xml:ns:obj1</objURI>
<objURI>urn:ietf:params:xml:ns:obj2</objURI>
<objURI>urn:ietf:params:xml:ns:obj3</objURI>
</svcs>
</login>
<clTRID>987654321</clTRID>
</command>
</epp>
3
2.2 Logout
Client:
Server:
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
<command>
<logout/>
<clTRID>transid</clTRID>
</command>
</epp>
<?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>transid</clTRID>
<svTRID>54321-XYZ</svTRID>
</trID>
</response>
</epp>