zydronium/internetee-registry
1
0
Fork 0
mirror of https://github.com/internetee/registry.git synced 2025-05-16 17:37:17 +02:00
Code Issues Projects Releases Packages Wiki Activity

Updated domain doc

Browse source
This commit is contained in:
Priit Tark 2015-01-22 13:08:48 +02:00
parent bd1b2aa687
commit b178d74bcc
1 changed files with 119 additions and 107 deletions
Download patch file Download diff file Expand all files Collapse all files

226
doc/epp/domain.md
View file

@ -2,142 +2,154 @@
### Domain create
Field name | Min-max | Field description
----------------------- | ------- | -----------------
`<create>` | 1 |
`-<domain:create>` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
`--<domain:name>` | 1 | Domain name. Can contain unicode characters.
`--<domain:period>` | 0-1 | Registration period for domain. Must add up to 1 / 2 / 3 years. <br> Attribute: unit="y/m/d"
`--<domain:registrant>` | 1 | Contact reference to the registrant
`--<domain:contact>` | 0-n | Contact reference. Admin contact is required if registrant is a <br> juridical person. Attribute: type="admin / tech"
`--<domain:ns>` | 1 |
`---<domain:hostAttr>` | 2-11 |
`----<domain:hostName>` | 1 | Hostname of the nameserver
`----<domain:hostAddr>` | 0-2 | Required if nameserver is under domain zone. Attribute ip="v4 / v6"
`<extension>` | 1 |
`-<secDNS:create>` | 0-1 | Attribute: xmlns:secDNS="urn:ietf:params:xml:ns:secDNS-1.1"
`--<secDNS:keyData>` | 1-n |
`---<secDNS:flags>` | 1 | Allowed values: 0, 256, 257
`---<secDNS:protocol>` | 1 | Allowed values: 3
`---<secDNS:alg>` | 1 | Allowed values: 3, 5, 6, 7, 8, 252, 253, 254, 255
`---<secDNS:pubKey>` | 1 | Public key
`-<eis:extdata>` | 1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0"
`--<eis:legalDocument>` | 1 | Base64 encoded document. Attribute: type="pdf"
`<clTRID>` | 0-1 | Client transaction id
Field name Min-max Field description
------------------------- ------- -----------------
<create> 1
<domain:create> 1 Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
<domain:name> 1 Domain name. Can contain unicode characters.
<domain:period> 0-1 Registration period for domain.
Must add up to 1 / 2 / 3 years.
Attribute: unit="y/m/d"
<domain:registrant> 1 Contact reference to the registrant
<domain:contact> 0-n Contact reference. Admin contact is required if registrant is
a juridical person. Attribute: type="admin / tech"
<domain:ns> 1
<domain:hostAttr> 2-11
<domain:hostName> 1 Hostname of the nameserver
<domain:hostAddr> 0-2 Required if nameserver is under domain zone.
Attribute ip="v4 / v6"
<extension> 1
<secDNS:create> 0-1 Attribute: xmlns:secDNS="urn:ietf:params:xml:ns:secDNS-1.1"
<secDNS:keyData> 1-n
<secDNS:flags> 1 Allowed values: 0, 256, 257
<secDNS:protocol> 1 Allowed values: 3
<secDNS:alg> 1 Allowed values: 3, 5, 6, 7, 8, 252, 253, 254, 255
<secDNS:pubKey> 1 Public key
<eis:extdata> 1 Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0"
<eis:legalDocument> 1 Base64 encoded document. Attribute: type="pdf"
<clTRID> 0-1 Client transaction id
[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-domain-with-valid-user-with-citizen-as-an-owner-creates-a-domain)
### Domain update
Field name | Min-max | Field description
------------------------ | -------- | -----------------
`<update>` | 1 |
`-<domain:update>` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
`--<domain:name>` | 1 | Domain name. Can contain unicode characters.
`--<domain:chg>` | 0-1 | Attributes to change
`---<domain:registrant>` | 0-1 | Contact reference to the registrant
`--<domain:add>` | 0-1 | Objects to add
`---<domain:contact>` | 0-n | Contact reference. Attribute: type="admin / tech"
`---<domain:status>` | 0-n | Status description. Attribute: s="clientDeleteProhibited / clientHold / <br> clientRenewProhibited / clientTransferProhibited / clientUpdateProhibited"
`---<domain:ns>` | 0-1 |
`----<domain:hostAttr>` | 1 |
`-----<domain:hostName>` | 1 | Hostname of the nameserver
`-----<domain:hostAddr>` | 0-2 | Required if nameserver is under domain zone. Attribute ip="v4 / v6"
`--<domain:rem>` | 0-1 | Objects to remove
`---<domain:contact>` | 0-n | Contact reference. Attribute: type="admin / tech"
`---<domain:status>` | 0-n | Attribute: s="clientDeleteProhibited / clientHold / clientRenewProhibited / <br> clientTransferProhibited / clientUpdateProhibited"
`---<domain:ns>` | 0-1 |
`----<domain:hostAttr>` | 1 |
`-----<domain:hostName>` | 1 | Hostname of the nameserver
`<extension>` | 0-1 | Required if registrant is changing
`-<secDNS:update>` | 0-1 | Attribute: xmlns:secDNS="urn:ietf:params:xml:ns:secDNS-1.1"
`--<secDNS:add>` | 0-1 |
`---<secDNS:keyData>` | 1-n |
`----<secDNS:flags>` | 1 | Allowed values: 0, 256, 257
`----<secDNS:protocol>` | 1 | Allowed values: 3
`----<secDNS:alg>` | 1 | Allowed values: 3, 5, 6, 7, 8, 252, 253, 254, 255
`----<secDNS:pubKey>` | 1 | Public key
`--<secDNS:rem>` | 0-1 |
`---<secDNS:keyData>` | 1-n |
`----<secDNS:pubKey>` | 1 | Public key
`-<eis:extdata>` | 0-1 | Required if registrant is changing. <br> Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0"
`--<eis:legalDocument>` | 1 | Base64 encoded document. Attribute: type="pdf"
`<clTRID>` | 0-1 | Client transaction id
Field name Min-max Field description
------------------------ -------- -----------------
<update> 1
<domain:update> 1 Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
<domain:name> 1 Domain name. Can contain unicode characters.
<domain:chg> 0-1 Attributes to change
<domain:registrant> 0-1 Contact reference to the registrant
<domain:add> 0-1 Objects to add
<domain:contact> 0-n Contact reference. Attribute: type="admin / tech"
<domain:status> 0-n Status description.
Attribute: s="clientDeleteProhibited / clientHold /
clientRenewProhibited / clientTransferProhibited /
clientUpdateProhibited"
<domain:ns> 0-1
<domain:hostAttr> 1
<domain:hostName> 1 Hostname of the nameserver
<domain:hostAddr> 0-2 Required if nameserver is under domain zone. Attribute ip="v4 / v6"
<domain:rem> 0-1 Objects to remove
<domain:contact> 0-n Contact reference. Attribute: type="admin / tech"
<domain:status> 0-n Attribute: s="clientDeleteProhibited / clientHold /
clientRenewProhibited / clientTransferProhibited /
clientUpdateProhibited"
<domain:ns> 0-1
<domain:hostAttr> 1
<domain:hostName> 1 Hostname of the nameserver
<extension> 0-1 Required if registrant is changing
<secDNS:update> 0-1 Attribute: xmlns:secDNS="urn:ietf:params:xml:ns:secDNS-1.1"
<secDNS:add> 0-1
<secDNS:keyData> 1-n
<secDNS:flags> 1 Allowed values: 0, 256, 257
<secDNS:protocol> 1 Allowed values: 3
<secDNS:alg> 1 Allowed values: 3, 5, 6, 7, 8, 252, 253, 254, 255
<secDNS:pubKey> 1 Public key
<secDNS:rem> 0-1
<secDNS:keyData> 1-n
<secDNS:pubKey> 1 Public key
<eis:extdata> 0-1 Required if registrant is changing.
Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0"
<eis:legalDocument> 1 Base64 encoded document. Attribute: type="pdf"
<clTRID> 0-1 Client transaction id
[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-domain-with-valid-user-with-valid-domain-updates-domain-and-adds-objects)
### Domain delete
Field name | Min-max | Field description
----------------------- | ------- | -----------------
`<delete>` | 1 |
`-<domain:delete>` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
`--<domain:name>` | 1 | Domain name. Can contain unicode characters.
`<extension>` | 1 |
`-<eis:extdata>` | 1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0"
`--<eis:legalDocument>` | 1 | Base64 encoded document. Attribute: type="pdf"
`<clTRID>` | 0-1 | Client transaction id
Field name Min-max Field description
----------------------- ------- -----------------
<delete> 1
<domain:delete> 1 Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
<domain:name> 1 Domain name. Can contain unicode characters.
<extension> 1
<eis:extdata> 1 Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0"
<eis:legalDocument> 1 Base64 encoded document. Attribute: type="pdf"
<clTRID> 0-1 Client transaction id
[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-domain-with-valid-user-with-valid-domain-deletes-domain)
### Domain info
Field name | Min-max | Field description
----------------------- | ------- | -----------------
`<info>` | 1 |
`-<domain:info>` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
`--<domain:name>` | 1 | Domain name. Can contain unicode characters. <br> Attribute: hosts="all / TODO"
`--<domain:authInfo>` | 0-1 | Required if registrar is not the owner of the domain.
`---<domain:pw>` | 1 | Domain password. Attribute: roid="String"
`<extension>` | 0-1 |
`-<eis:extdata>` | 0-1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0"
`--<eis:legalDocument>` | 1 | Base64 encoded document. Attribute: type="pdf"
`<clTRID>` | 0-1 | Client transaction id
Field name Min-max Field description
----------------------- ------- -----------------
<info> 1
<domain:info> 1 Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
<domain:name> 1 Domain name. Can contain unicode characters. <br> Attribute: hosts="all / TODO"
<domain:authInfo> 0-1 Required if registrar is not the owner of the domain.
<domain:pw> 1 Domain password. Attribute: roid="String"
<extension> 0-1
<eis:extdata> 0-1 Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0"
<eis:legalDocument> 1 Base64 encoded document. Attribute: type="pdf"
<clTRID> 0-1 Client transaction id
[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-domain-with-valid-user-with-valid-domain-returns-domain-info)
### Domain renew
Field name | Min-max | Field description
----------------------- | ------- | -----------------
`<renew>` | 1 |
`-<domain:renew>` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
`--<domain:name>` | 1 | Domain name. Can contain unicode characters. <br> Attribute: hosts="all / TODO"
`--<domain:curExpDate>` | 1 | Current expiry date (ISO8601 format)
`--<domain:period>` | 1 | Registration period for domain. Must add up to 1 / 2 / 3 years. <br> Attribute: unit="y/m/d"
`<extension>` | 0-1 |
`-<eis:extdata>` | 0-1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0"
`--<eis:legalDocument>` | 1 | Base64 encoded document. Attribute: type="pdf"
`<clTRID>` | 0-1 | Client transaction id
Field name Min-max Field description
----------------------- ------- -----------------
<renew> 1
<domain:renew> 1 Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
<domain:name> 1 Domain name. Can contain unicode characters.
Attribute: hosts="all / TODO"
<domain:curExpDate> 1 Current expiry date (ISO8601 format)
<domain:period> 1 Registration period for domain. Must add up to 1 / 2 / 3 years. <br> Attribute: unit="y/m/d"
<extension> 0-1
<eis:extdata> 0-1 Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0"
<eis:legalDocument> 1 Base64 encoded document. Attribute: type="pdf"
<clTRID> 0-1 Client transaction id
[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-domain-with-valid-user-with-valid-domain-renews-a-domain)
### Domain transfer
Field name | Min-max | Field description
----------------------- | ------- | -----------------
`<transfer>` | 1 |
`-<domain:transfer>` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
`--<domain:name>` | 1 | Domain name. Can contain unicode characters. <br> Attribute: hosts="all / TODO"
`--<domain:authInfo>` | 1 |
`---<domain:pw>` | 1 | Domain password. Attribute: roid="String"
`<extension>` | 0-1 |
`-<eis:extdata>` | 0-1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0"
`--<eis:legalDocument>` | 1 | Base64 encoded document. Attribute: type="pdf"
`<clTRID>` | 0-1 | Client transaction id
Field name Min-max Field description
----------------------- ------- -----------------
<transfer> 1
<domain:transfer> 1 Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
<domain:name> 1 Domain name. Can contain unicode characters.
Attribute: hosts="all / TODO"
<domain:authInfo> 1
<domain:pw> 1 Domain password. Attribute: roid="String"
<extension> 0-1
<eis:extdata> 0-1 Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0"
<eis:legalDocument> 1 Base64 encoded document. Attribute: type="pdf"
<clTRID> 0-1 Client transaction id
[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-domain-with-valid-user-with-two-epp-users-transfers-a-domain)
### Domain check
Field name | Min-max | Field description
----------------------- | ------- | -----------------
`<check>` | 1 |
`-<domain:check>` | 1 | Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
`--<domain:name>` | 1 | Domain name. Can contain unicode characters. <br> Attribute: hosts="all / TODO"
`<extension>` | 0-1 |
`-<eis:extdata>` | 0-1 | Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0"
`--<eis:legalDocument>` | 1 | Base64 encoded document. Attribute: type="pdf"
`<clTRID>` | 0-1 | Client transaction id
Field name Min-max Field description
----------------------- ------- -----------------
<check> 1
<domain:check> 1 Attribute: xmlns:domain="urn:ietf:params:xml:ns:domain-1.0"
<domain:name> 1 Domain name. Can contain unicode characters. <br> Attribute: hosts="all / TODO"
<extension> 0-1
<eis:extdata> 0-1 Attribute: xmlns:eis="urn:ee:eis:xml:epp:eis-1.0"
<eis:legalDocument> 1 Base64 encoded document. Attribute: type="pdf"
<clTRID> 0-1 Client transaction id
[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-domain-with-valid-user-checks-a-domain)