gtld registrar manual part iv : epp registrar manual - pa… · gtld registrar manual part iv: epp...

23
gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 1 gTLD Registrar Manual Part IV : EPP

Upload: others

Post on 13-Jul-2020

16 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

1

10 n o v ember 2011

Budgetontwerp

2012gTLD Registrar Manual

Part IV : EPP

Page 2: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

2

Table of contents

Table of contents .............................................................................................................................................. 2

1 Introduction .................................................................................................................................................... 5 1.1. Technical setup..................................................................................................................................................... 5 1.2. Userid and password .......................................................................................................................................... 5 1.3. IP whitelisting ....................................................................................................................................................... 6 1.4. Session management .......................................................................................................................................... 6 1.5. IDN ............................................................................................................................................................................ 6 1.6. Basic requirements ............................................................................................................................................. 6 1.7. Transactions .......................................................................................................................................................... 6 1.8. EPP basics ............................................................................................................................................................... 7

2 Hello/greeting ................................................................................................................................................ 7

3 Login .................................................................................................................................................................. 7 3.1 Input data ..................................................................................................................................................................... 8 3.2 Prerequisites ................................................................................................................................................................ 8 3.3 Transformations ........................................................................................................................................................ 8

4 Logout ................................................................................................................................................................ 8 4.1 Input data ..................................................................................................................................................................... 8 4.2 Prerequisites ................................................................................................................................................................ 9 4.3 Transformations ........................................................................................................................................................ 9

5 Check contact .................................................................................................................................................. 9 5.1 Input data ..................................................................................................................................................................... 9 5.2 Prerequisites ................................................................................................................................................................ 9 5.3 Transformations ........................................................................................................................................................ 9 5.4 Response details ......................................................................................................................................................... 9

6 Info contact .................................................................................................................................................... 10 6.1 Input data .................................................................................................................................................................. 10 6.2 Prerequisites ............................................................................................................................................................. 10 6.3 Transformations ..................................................................................................................................................... 10 6.4 Response details ...................................................................................................................................................... 10

7 Create contact ............................................................................................................................................... 10 7.1 Input data .................................................................................................................................................................. 10 7.2 Prerequisites ............................................................................................................................................................. 11 7.3 Transformations ..................................................................................................................................................... 11 7.4 Response details ...................................................................................................................................................... 12

8 Update contact ............................................................................................................................................. 12 8.1 Input data .................................................................................................................................................................. 12 8.2 Prerequisites ............................................................................................................................................................. 12 8.3 Transformations ..................................................................................................................................................... 12

9 Delete contact ............................................................................................................................................... 12 9.1 Input data .................................................................................................................................................................. 13 9.2 Prerequisites ............................................................................................................................................................. 13 9.3 Transformations ..................................................................................................................................................... 13

10 Transfer contact........................................................................................................................................ 13

11 Renew contact ........................................................................................................................................... 13

12 Check domain............................................................................................................................................. 13

Page 3: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

3

12.1 Input data ............................................................................................................................................................... 13 12.2 Prerequisites .......................................................................................................................................................... 14 12.3 Transformations ................................................................................................................................................... 14 12.4 Response details ................................................................................................................................................... 14

13 Info domain................................................................................................................................................. 14 13.1 Input data ............................................................................................................................................................... 14 13.2 Prerequisites .......................................................................................................................................................... 14 13.3 Transformations ................................................................................................................................................... 15 13.4 Response details ................................................................................................................................................... 15

14 Create domain ........................................................................................................................................... 15 14.1 Input data ............................................................................................................................................................... 15 14.2 Prerequisites .......................................................................................................................................................... 16 14.3 Transformations ................................................................................................................................................... 16 14.4 Response details ................................................................................................................................................... 16

15 Update domain .......................................................................................................................................... 16 15.1 Input data ............................................................................................................................................................... 16 15.2 Prerequisites .......................................................................................................................................................... 16 15.3 Transformations ................................................................................................................................................... 17

16 Renew domain ........................................................................................................................................... 17 16.1 Input data ............................................................................................................................................................... 17 16.2 Prerequisites .......................................................................................................................................................... 17 16.3 Transformations ................................................................................................................................................... 17

17 Transfer domain ....................................................................................................................................... 18

18 Transfer domain – request ................................................................................................................... 18 18.1 Input data ............................................................................................................................................................... 18 18.2 Prerequisites .......................................................................................................................................................... 18 18.3 Transformations ................................................................................................................................................... 18

19 Transfer domain – approve .................................................................................................................. 18 19.1 Prerequisites .......................................................................................................................................................... 19 19.2 Transformations ................................................................................................................................................... 19

20 Transfer domain – reject ....................................................................................................................... 19 20.1 Prerequisites .......................................................................................................................................................... 19 20.2 Transformations ................................................................................................................................................... 19

21 Transfer domain – cancel ...................................................................................................................... 19 21.1 Prerequisites .......................................................................................................................................................... 19 21.2 Transformations ................................................................................................................................................... 20

22 Transfer domain – query ....................................................................................................................... 20 22.1 Prerequisites .......................................................................................................................................................... 20 22.2 Transformations ................................................................................................................................................... 20

23 Delete domain............................................................................................................................................ 20 23.1 Prerequisites .......................................................................................................................................................... 20 23.2 Transformations ................................................................................................................................................... 21

24 Restore domain ......................................................................................................................................... 21

25 Restore domain – request ..................................................................................................................... 21 25.1 Input data ............................................................................................................................................................... 21 25.2 Prerequisites .......................................................................................................................................................... 21 25.3 Transformations ................................................................................................................................................... 21

Page 4: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

4

26 Restore domain – report ........................................................................................................................ 21 26.1 Input data ............................................................................................................................................................... 21 26.2 Prerequisites .......................................................................................................................................................... 22 26.3 Transformations ................................................................................................................................................... 22

27 Host ................................................................................................................................................................ 22

28 Poll ................................................................................................................................................................. 22 28.1 Prerequisites .......................................................................................................................................................... 22 28.2 Transformations ................................................................................................................................................... 23 28.3 Response details ................................................................................................................................................... 23

Page 5: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

5

1 Introduction

1.1. Technical setup

The EPP interface for DNS Belgium is RFC compliant and ICANN compliant for the gTLD registries.

For a complete reference of the standard syntax, we refer to the internet RFC documents, they explain in detail the valid content of a document:

• RFC 5730: Extensible Provisioning Protocol.

• RFC 5731: (EPP) Domain Name Mapping.

• RFC 5732: (EPP) Host Mapping.

• RFC 5733: (EPP) Contact Mapping.

• RFC 5734: (EPP) Transport over TCP.

• RFC 4033 : DNSSEC, Introduction and Requirements.

• RFC 4034 : DNSSEC, Resource records.

• RFC 4035 : DNSSEC, Protocol modifications.

• RFC 4641 : DNSSEC, Operational best practices.

• RFC 5155 : DNSSEC, NSEC3.

• RFC 5702 : DNSSEC, SHA2.

• RFC 5910: DNSSEC & EPP.

The implementation of IDN at DNS Belgium is based on the IDNA 2008 standard and the following reference documents:

• RFC 5890: Internationalized Domain Names for Applications (IDNA): Definitions and Document Framework

• RFC 5891: Internationalized Domain Names in Applications (IDNA): Protocol

• RFC 5892: The Unicode Code Points and Internationalized Domain Names for Applications (IDNA)

• RFC 5894: Internationalized Domain Names for Applications (IDNA): Background, Explanation, and Rationale

• RFC 3492: Punycode: A Bootstring encoding of Unicode for Internationalized Domain Names in Applications (IDNA)

The EPP interface is solely accessible via SLL protocol and accepts utf-8 character encoding only. Host and port can be found in the Quickstart document.

DNS BELGIUM HAS A GUI INTERFACE, INCLUDING EXAMPLE EPP COMMANDS, THAT CAN BE USED TO TEST THE EPP SYSTEM. THIS CAN BE FOUND IN THE KNOWLEDGEBASE ON OUR PUBLIC WEBSITE.

1.2. Userid and password

To access the EPP interface, you need a user and password. The user is the registrar handle that you have been attributed upon activation as a registrar. The password can be set in the registrar web interface by a user with the tech role.

Page 6: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

6

1.3. IP whitelisting

Before connecting to the EPP interface, DNS Belgium needs to know from which IP addresses you will be connecting. These can be set in the registrar web interface by a user with the tech role.

1.4. Session management

DNS Belgium allows 4 simultaneous EPP sessions (connections) per registrar with our EPP server. When you open more connections, the oldest connection will be closed automatically.

As a registrar, you can specify 10 IP addresses from which you are allowed to connect with our EPP server. Although you have 10 IP addresses, DNS Belgium allows only 4 simultaneous connections. In other words, the number of IP addresses that you specify is not related in any way with the number of allowed connections.

Connections which are idle for more than 4 minutes will be closed by our EPP server.

1.5. IDN

We accept both U-label and A-label as input for EPP. The EPP response will only use the A-label for IDN names, both in succeeded and in error messages. If you register a non-IDN name, the domain name is returned as you entered it.

For name servers, we also accept both U-label and A-label. The EPP response will only use the A-label for IDN name servers.

1.6. Basic requirements

To have commands executed on the server, the following preconditions must be fulfilled:

• The client must be properly authorized to the server, by establishing a proper EPP session (login), and connection from a well-known IP address. We provide a server certificate for validation, this can be found on our website.

• The client must send EPP commands that do correctly validate against the EPP XML schema files.

1.7. Transactions

EPP commands fall into three categories:

• Session management: is used to establish and end persistent sessions with the EPP server.

• Query: is used to perform read-only information retrieval.

• Transform: is used to perform read-write transactional object management operations.

The following pages give an overview of the different EPP commands that can be exchanged between the client and the server. DNS Belgium follows the relevant RFC’s as listed above. Where choices had to be made according to the RFCs, they are described in the sections below. Each command has 4 subsections (where applicable) with relevant information:

• Input data: Clarifications to the relevant RFC and more information on optional elements or choices made based on the RFC concerning the EPP request.

Page 7: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

7

• Prerequisites: Preconditions that must be met for a command to succeed.

• Transformations: Changes to the registration database.

• Response details: Clarifications to the relevant RFC and more information on optional elements or choices made based on the RFC concerning the EPP response.

1.8. EPP basics

DNS Belgium follows the RFCs relating to EPP. Following decisions have been made where the RFCs give a choice:

• The EPP server only accepts utf-8 character encoding.

• The EPP server offers contact and domain objects.

• Domain names must include the TLD (e.g. “example.brussels”).

• Newly created domain names are active immediately.

• “Host attributes” must be used in domains.

• External hosts do not allow for IP addresses, while internal hosts (below the TLD) require at least one IP address (glue record).

• In domain objects, exactly one registrant, and at least one tech and admin contact is required. The contact type billing is not supported.

• In contact objects, we accept both “type=int” and “type=loc” fields. If you want to use non-ASCII characters in the address of your contact, you should use “type=loc”.

• Contact objects require an empty authInfo element on creation.

• Contact transfers are not supported.

• Domain names can be created without references to hosts – however, this also means such domains are not included in the DNS.

• Domain transfer requests require the authInfo of the respective domain object.

• Domain Transfers are auto-approved after 5 days (or, 5 minutes on the sandbox system), but can also be o approved or rejected by the losing registrar. o cancelled by the gaining registrar.

2 Hello/greeting The client can initiate a hello transaction any time, the server will reply with a greeting.

3 Login The login command is used to authenticate the client to the EPP server and establish a session with the EPP server. It must be sent before any other command (except hello). The user id and EPP password will be used to authenticate the party that wants to set up the session.

During an active session, a login command is rejected by the server. A session should be terminated with the logout command.

Page 8: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

8

3.1 Input data

Tag Occurrence min-max

Remarks

clID 1 Contains the registrar ID of the connecting client.

pw 1 Contains the EPP password of the connecting client (registrar). This can be set by a user with the tech role via the registrar web interface.

newPW 0-1 A new password can be set. Password changing is only possible at login.

options 1 Setting version and language, which is ‘1.0’ and ‘en’.

svcs 1 For indicating namespace URIs representing objects to be managed during the session. At least one extension must be mentioned.

3.2 Prerequisites

• Number of active sessions by the client can’t exceed the administrative limit.

• The client is not logged in for this session.

• The “clID” must be valid.

• The “pw” must be valid for the given “clID”.

• The options and object URIs given by the client must be supported by the server.

• The client must not have exceeded the rate limit policy (e.g. number of sessions).

• If a “newPw” is given, the new password must adhere to the password policy set by the registry. The password policy is explained in the General document.

3.3 Transformations

This command may modify the password of the client but does not apply any transformation for domain or contact objects.

A new EPP session is established.

4 Logout The logout command is used to close a session with the EPP server. Due to server policy, a server may also terminate a session (e.g. because of inactivity timeout).

4.1 Input data

The logout command does not need any input data.

Page 9: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

9

4.2 Prerequisites

The logout command can only be used during an active session.

4.3 Transformations

This command does not apply any transformations to registry objects.

The current session is closed.

5 Check contact The check contact command can be used to determine if a contact object can be provisioned in the registry.

5.1 Input data

Tag Occurrence min-max

Remarks

id 1-5 The unique identifier of the contact object is required.

5.2 Prerequisites

• The number of contact IDs to be checked for must be between 1 and 5 inclusive.

• The naming policy for contact IDs must be respected.

5.3 Transformations

This command does not apply any transformations to registry objects.

5.4 Response details

In case the command was successful, the response contains an “avail” attribute with value “true” or “false”. In case of “false”, the reason element will contain the reason why the object can’t be provisioned. Possible reasons are:

• Invalid

• In use

Page 10: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

10

6 Info contact

The info contact command can be used to retrieve information about a contact object.

6.1 Input data

Tag Occurrence min-max

Remarks

id 1 The unique id of the contact object is required.

authInfo 0-1 Must be provided if you are not the sponsoring registrar. The authInfo must match one of the associated domains with the contact as registrant or admin contact.

6.2 Prerequisites

• The contact ID must exist.

• The authInfo must match one of the associated domains with the contact as registrant or admin contact for anyone other than the sponsoring registrar.

• If the authInfo is given, it must be correct.

6.3 Transformations

This command does not apply any transformations to registry objects.

6.4 Response details

In case the command was successful, the response contains an infData element with information about the contact.

7 Create contact The create contact command can be used to create a new contact object.

7.1 Input data

Tag Occurrence min-max

Remarks

id 1 The unique id of the contact object is required.

Page 11: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

11

Following characters may be used in a type ‘loc’ postalInfo block:

!"#\$%&'()*+,./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~ ¡¢£¤¥¦§¨©ª«¬­®¯°±²³´µ¶·¸¹º»¼½¾¿ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö÷øùúûüýþÿŒœŠšŸŽž€

7.2 Prerequisites

• The contact ID must be available.

• The contact ID must not start with 'clone'.

• Naming conventions must be followed.

• Required elements must be provided.

• authInfo element must be provided. Its value is ignored.

7.3 Transformations

This command creates a new contact object with the requested contact ID.

The characters used for the contact id should be from the set [a-z,0-9,-,_].

postalInfo 1 Required attribute type=’loc’ or ‘int’. When using type ‘int’, only ASCII may be used. When using type ‘loc’, non-ASCII characters may be used.

Only 1 postalInfo block is accepted.

cc 1 The cc element should contain a country code from ISO 3166-1 list with a few additional codes from the ISO 3166 reserved codes list.

The list we support can be viewed on our website in the 'Library'.

voice 1 Is required by DNS Belgium. Contains the telephone number of the contact that is being created. A phone number is a string that must begin with a plus sign ('+'), followed by a country code, followed by a dot ('.'), followed by a sequence of digits representing the telephone number.

E.g. DNS Belgium's phone number is +32.16284970.

fax 0-1 The syntax is the same as the voice element.

email 1 E-mail address syntax is defined in [RFC 2822].

authInfo 1 Must be provided, its value will be ignored.

disclosure 0 This element will be ignored.

Page 12: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

12

7.4 Response details

In case the command was successful, the response contains an resData element with the contact ID and time of creation of the contact object.

8 Update contact The update contact command can be used to modify the attributes of an existing contact object.

8.1 Input data

At least one <contact:add>, <contact:rem>, or <contact:chg> element MUST be provided.

Tag Occurrence min-max

Remarks

id 1 The unique id of the contact object is required.

status 0 This element is not supported.

addr 0-1 A complete <addr> block must be provided when updating the address information.

authInfo 1 Must be provided, its value will be ignored.

disclosure 0 This element will be ignored.

8.2 Prerequisites

• Client must be authorized to update the contact (only the sponsoring registrar is allowed to update the contact).

• The contact ID must exist.

• Naming conventions must be followed.

• Required elements must be provided.

• authInfo element must be provided, its value is ignored.

8.3 Transformations

This command updates the contact object with the requested contact ID.

9 Delete contact The delete contact command can be used to delete an existing contact object. Only unlinked contact objects can be deleted.

Page 13: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

13

9.1 Input data

Tag Occurrence min-max

Remarks

id 1 The unique id of the contact object is required.

9.2 Prerequisites

• Client must be authorized to delete the contact (only the sponsoring registrar is allowed to delete the contact).

• The contact ID must exist.

• The contact object must not be ‘linked’ to an active registration.

• Naming conventions must be followed.

• Required elements must be provided.

9.3 Transformations

This command removes the contact object with the requested contact ID immediately.

10 Transfer contact This command is not implemented.

11 Renew contact This command is not implemented.

12 Check domain The check domain command can be used to determine if a domain object can be provisioned in the registry.

12.1 Input data

Tag Occurrence min-max

Remarks

name 1-5 The fully qualified domain name must be used. The U-label or the A-label may be used.

Page 14: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

14

12.2 Prerequisites

• The number of domain names to be checked must be between 1 and 5 inclusive.

• The naming policy for domain names must be respected.

12.3 Transformations

This command does not apply any transformations to registry objects.

12.4 Response details

In case the command was successful, the response contains an “avail” attribute with value “true” or “false”. In case of “false”, the reason element will contain the reason why the object can’t be provisioned. Possible reasons are:

• Registered

• Reserved

• Invalid

In case of an IDN domain name, the response will contain the A-label.

13 Info domain The info domain command can be used to retrieve information about a domain object.

13.1 Input data

Tag Occurrence min-max

Remarks

name 1 The fully qualified domain name must be used. The U-label or the A-label may be used.

authInfo 0-1 Must be provided if you are not the sponsoring registrar.

13.2 Prerequisites

• The domain name must exist.

• The authInfo must be provided for anyone other than the sponsoring registrar.

• If the authInfo is given, it must be correct.

Page 15: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

15

13.3 Transformations

This command does not apply any transformations to registry objects.

13.4 Response details

In case the command was successful, the response contains an infData element with information about the domain.

14 Create domain The create domain command can be used to create a new domain object.

14.1 Input data

Tag Occurrence min-max

Remarks

name 1 The fully qualified domain name to be created.

period 0-1 The default registration period is one year.

If the period element is provided it must use unit=’y’ and the requested years must be between 1 and 10 inclusive.

ns 0-13 DNS Belgium has chosen to work with nameservers as attributes to a domain name. This means you will need to use the <hostAttr> element for nameservers. If the nameserver is a subordinate of the domain name, an IP address is required.

For IDN nameservers, only A-labels are allowed.

registrant 1 The contact identifier of the contact that will be registrant.

contact 2-9 There must be at least one contact of type ‘admin’ and at least one contact of type ‘tech’. The contact of type ‘billing’ is not supported.

authInfo 1 The authorization information associated with the domain name.

secDNS 0-6 DNS Belgium has chosen to use dsData for the implementation of DNSSEC. Using Keydata will result in an error.

maxSigLive 0 This element is not supported.

Page 16: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

16

14.2 Prerequisites

• The domain name must be available.

• Naming conventions must be followed.

• Required elements must be provided.

• Protected transactions threshold must not be reached.

14.3 Transformations

The domain name is created with the attributes provided. In case nameservers are provided, a DNS update transaction is queued. A billing line is created. The domain name enters the add grace period.

14.4 Response details

In case the command was successful, the response contains an creData element with information about the domain.

15 Update domain The update domain command can be used to modify the attributes of an existing domain object.

15.1 Input data

At least one <domain:add>, <domain:rem>, or <domain:chg> element MUST be provided.

Tag Occurrence min-max

Remarks

name 1 The fully qualified domain name to be updated.

registrant 0-1 It is impossible to remove the registrant by adding an empty element.

authInfo 0-1 It is impossible to remove authorization information with the <domain:null> element.

The same requirements apply as for the create domain command.

15.2 Prerequisites

• Client must be authorized to update the domain (only the sponsoring registrar is allowed to update the domain).

• The domain name must exist.

• Naming conventions must be followed.

• clientUpdateProhibited/serverUpdateProhibited must not be set.

Page 17: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

17

• Add/rem/chg restrictions are enforced: Add and remove is allowed for name servers, contacts and status elements. Changing is allowed for registrant and authInfo.

• All minimal required attributes must still be present after the update.

• The maximum allowed number of attributes must be satisfied after the update.

15.3 Transformations

This command updates the domain object. Name server changes may lead to DNS changes.

16 Renew domain The renew domain command extends the registration period of a domain object.

16.1 Input data

Tag Occurrence min-max

Remarks

name 1 The fully qualified domain name to be renewed.

period 0-1 The default renewal period is one year.

If the period element is provided it must use unit=’y’ and the requested years must be between 1 and 10 inclusive.

16.2 Prerequisites

• Client must be authorized to renew the domain (only the sponsoring registrar is allowed to renew the domain).

• The domain name must exist.

• Naming conventions must be followed.

• Required elements must be provided.

• Protected transactions threshold must not be reached.

• clientRenewProhibited/serverRenewProhibited must not be set.

• curExpDate must be correct.

• The renew period does not extend the registration period beyond the maximum registration period of 10 years.

16.3 Transformations

The expiration date of the domain name is changed accordingly and a billing line is created. If the domain name was in a grace period, this period is ended. The domain name enters the renew grace period.

Page 18: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

18

17 Transfer domain The transfer domain command transfers a domain from a losing registrar to a gaining registrar. The required attribute ‘op’ identifies the transfer operation to be performed. The subcommands are explained in the following sections.

Please note that contact objects are cloned during transfer according to DNS Belgium policy. For more information on the transfer procedure/lifecycle, please read the General document.

18 Transfer domain – request The transfer domain command with op=’request’ can be used to initiate the transfer.

18.1 Input data

Tag Occurrence min-max

Remarks

name 1 The fully qualified domain name to be transferred.

period 0-1 If the period is provided, it should be one year.

If not, the default period is one year.

authInfo 1 The authorization information associated with the domain name.

18.2 Prerequisites

• The domain name must exist.

• authInfo provided in the request must match the authInfo of the domain name.

• Client must not be the sponsoring registrar.

• Naming conventions must be followed.

• Required elements must be provided.

• Protected transactions threshold must not be reached.

• clientTransferProhibited/serverTransferProhibited must not be set.

• Domain must not be in ‘pendingTransfer’.

18.3 Transformations

The status ‘pendingTransfer’ is added to the domain object.

19 Transfer domain – approve The transfer domain command with op=’approve’ can be used to approve the transfer.

Page 19: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

19

19.1 Prerequisites

• The domain name must exist.

• If the authInfo is provided, it should match the authInfo of the domain name.

• Client must be the sponsoring registrar.

• Naming conventions must be followed.

• Required elements must be provided.

• Domain must be in ‘pendingTransfer’.

19.2 Transformations

The domain is transferred to the gaining registrar, all contacts are checked and cloned (if needed) for the gaining registrar and a new authInfo is generated (this can be picked up using <info-domain>). If the registration period can be extended with one year, it will be and a billing line will be created. If the domain was in auto-renew grace period, the losing registrar will be refunded. If the domain was in renew grace period, this period is ended. The domain name enters the transfer grace period.

20 Transfer domain – reject The transfer domain command with op=’reject’ can be used to reject the transfer.

20.1 Prerequisites

• The domain name must exist.

• If the authInfo is provided, it should match the authInfo of the domain name.

• Client must be the sponsoring registrar.

• Naming conventions must be followed.

• Required elements must be provided.

• Domain must be in ‘pendingTransfer’.

20.2 Transformations

The status ‘pendingTransfer’ is removed from the domain object. The transfer does not take place. If the domain name is past its expiration date and the client/serverrenewProhibited flag is set, the domain name goes into redemption, otherwise an auto-renew is performed immediately.

21 Transfer domain – cancel The transfer domain command with op=’cancel’ can be used to cancel the transfer.

21.1 Prerequisites

• The domain name must exist.

Page 20: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

20

• authInfo provided in the request matches the authInfo of the domain name.

• Client must be the gaining registrar.

• Naming conventions must be followed.

• Required elements must be provided.

• Domain must be in ‘pendingTransfer’.

21.2 Transformations

The status ‘pendingTransfer’ is removed from the domain object. The transfer does not take place. If the domain name is past its expiration date and the client/serverrenewProhibited flag is set, the domain name goes into redemption, otherwise an auto-renew is performed immediately.

22 Transfer domain – query The transfer domain command with op=’query’ can be used to retrieve information about a transfer.

22.1 Prerequisites

• The domain name must exist.

• If the authInfo is provided, it should match the authInfo of the domain name.

• If the domain is in ‘pendingTransfer’, any client other than the sponsoring registrar must provide authInfo.

• If the domain has a completed transfer in the past, any client other than the gaining (this is the currently sponsoring) registrar must provide authInfo.

• Naming conventions must be followed.

• Required elements must be provided.

22.2 Transformations

This command does not apply any transformations to registry objects.

23 Delete domain The delete domain command can be used to delete a domain object.

23.1 Prerequisites

• Client must be authorized to delete the domain (only the sponsoring registrar is allowed to delete the domain).

• The domain name must exist.

• Naming conventions must be followed.

• Required elements must be provided.

• Protected transactions threshold must not be reached.

• clientDeleteProhibited/serverDeleteProhibited must not be set.

Page 21: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

21

23.2 Transformations

The status ‘redemptionPeriod’ is added to the domain object. A DNS update transaction is queued to remove the domain name from the zone. If the domain name was in a grace period, the registrar will be refunded.

24 Restore domain The restore domain command can be used to restore a domain object that is in redemption. A restore request and a restore report command are required. These are extensions to the update domain command.

25 Restore domain – request

25.1 Input data

The update domain command should provide the <rgp:update> extension.

25.2 Prerequisites

• Client must be authorized to restore the domain (only the sponsoring registrar is allowed to restore the domain).

• The domain name must exist.

• The domain must be in ‘redemptionPeriod’

• Naming conventions must be followed.

• Required elements must be provided.

• Protected transactions threshold must not be reached.

25.3 Transformations

The status ‘redemptionPeriod’ is removed from the domain object. The status ‘pendingRestore’ is added to the domain object.

26 Restore domain – report

26.1 Input data

The update domain command should provide the <rgp:update> extension.

Page 22: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

22

26.2 Prerequisites

• Client must be authorized to restore the domain (only the sponsoring registrar is allowed to restore the domain).

• The domain name must exist.

• The domain must be in ‘pendingRestore’.

• Naming conventions must be followed.

• Required elements must be provided.

26.3 Transformations

The domain object is restored to its status before it was deleted. In case the domain has nameservers, a DNS update transaction is queued. A billing line is created. If the domain name is past its expiration date, an auto-renew is performed immediately and the domain name enters the auto-renew grace period.

27 Host Host objects are not implemented.

28 Poll The poll command is used to discover and retrieve server-generated service messages for the client. The server maintains a message queue for each client.

Message polling consists of two parts – the query (message polling) and the deletion (message acknowledge) of the message on the server.

After a successful request with op=”req” from the registrar, the DNS Belgium server will send a reply containing a message counter, a server-unique message identifier and the first message from the queue. In case the message queue is empty, the server will reply that there are no messages pending.

Each message sent from the DNS Belgium server must be acknowledged by the registrar by sending an “ack” request containing the unique id of the message that is being acknowledged. After receiving the acknowledgement from the registrar, the DNS Belgium server will send a reply confirming the registrar's acknowledgement and indicating the new number of messages in the queue

Only the oldest message stored on the system is displayed. This means that the acknowledgement is required in order to view the next message.

Note that there is no follow-up for unacknowledged poll messages. The poll command is the only way to receive server-generated messages. DNS Belgium recommends to check poll messages daily.

28.1 Prerequisites

• Client must be authorized.

• A message can only be deleted if the correct message id is provided.

Page 23: gTLD Registrar Manual Part IV : EPP Registrar Manual - Pa… · gTLD Registrar Manual Part IV: EPP Copyright © 2016 DNS Belgium vzw/asbl 2 Table of contents Table of contents

gTLD Registrar Manual Part IV: EPP

Copyright © 2016 DNS Belgium vzw/asbl

23

28.2 Transformations

This command does not apply any transformations to registry objects. It may dequeue messages.

28.3 Response details

Information returned in the response may be with or without object specific information. The object specific information is contained in a resData element.