zydronium/google-nomulus
1
0
Fork 0
mirror of https://github.com/google/nomulus.git synced 2025-06-15 17:04:45 +02:00
Code Issues Projects Releases Packages Wiki Activity

Reflow markdown flow documentation to 80 characters

Browse source 
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=135500481
This commit is contained in:
mmuller 2016-10-07 11:48:42 -07:00 • committed by Ben McIlwain
parent b224a90a4c
commit 86d8f35f79
1 changed files with 276 additions and 182 deletions
Download patch file Download diff file Expand all files Collapse all files

458
docs/flows.md
View file

@ -6,6 +6,7 @@
An EPP flow that updates a contact.
### Errors
* 2004
@ -17,7 +18,8 @@ An EPP flow that updates a contact.
* 2303
* Resource with this id does not exist.
* 2304
* This resource has clientUpdateProhibited on it, and the update does not clear that status.
* This resource has clientUpdateProhibited on it, and the update does not
clear that status.
* Resource status prohibits this operation.
* 2306
* Cannot add and remove the same value.
@ -29,11 +31,12 @@ An EPP flow that updates a contact.
An EPP flow that requests a transfer on a contact.
The "gaining" registrar requests a transfer from the "losing" (aka current) registrar. The
losing registrar has a "transfer" time period to respond (by default five days) after which the
transfer is automatically approved. Within that window, the transfer might be approved explicitly
by the losing registrar or rejected, and the gaining registrar can also cancel the transfer
request.
The "gaining" registrar requests a transfer from the "losing" (aka current)
registrar. The losing registrar has a "transfer" time period to respond (by
default five days) after which the transfer is automatically approved. Within
that window, the transfer might be approved explicitly by the losing registrar
or rejected, and the gaining registrar can also cancel the transfer request.
### Errors
@ -54,10 +57,11 @@ request.
An EPP flow that rejects a pending transfer on a contact.
The "gaining" registrar requests a transfer from the "losing" (aka current) registrar. The
losing registrar has a "transfer" time period to respond (by default five days) after which the
transfer is automatically approved. Within that window, this flow allows the losing client to
reject the transfer request.
The "gaining" registrar requests a transfer from the "losing" (aka current)
registrar. The losing registrar has a "transfer" time period to respond (by
default five days) after which the transfer is automatically approved. Within
that window, this flow allows the losing client to reject the transfer request.
### Errors
@ -76,12 +80,14 @@ reject the transfer request.
An EPP flow that queries a pending transfer on a contact.
The "gaining" registrar requests a transfer from the "losing" (aka current) registrar. The
losing registrar has a "transfer" time period to respond (by default five days) after which the
transfer is automatically approved. This flow can be used by the gaining or losing registrars
(or anyone with the correct authId) to see the status of a transfer, which may still be pending
or may have been approved, rejected, cancelled or implicitly approved by virtue of the transfer
period expiring.
The "gaining" registrar requests a transfer from the "losing" (aka current)
registrar. The losing registrar has a "transfer" time period to respond (by
default five days) after which the transfer is automatically approved. This flow
can be used by the gaining or losing registrars (or anyone with the correct
authId) to see the status of a transfer, which may still be pending or may have
been approved, rejected, cancelled or implicitly approved by virtue of the
transfer period expiring.
### Errors
@ -100,10 +106,12 @@ period expiring.
An EPP flow that cancels a pending transfer on a contact.
The "gaining" registrar requests a transfer from the "losing" (aka current) registrar. The
losing registrar has a "transfer" time period to respond (by default five days) after which the
transfer is automatically approved. Within that window, this flow allows the gaining client to
withdraw the transfer request.
The "gaining" registrar requests a transfer from the "losing" (aka current)
registrar. The losing registrar has a "transfer" time period to respond (by
default five days) after which the transfer is automatically approved. Within
that window, this flow allows the gaining client to withdraw the transfer
request.
### Errors
@ -122,10 +130,12 @@ withdraw the transfer request.
An EPP flow that approves a pending transfer on a contact.
The "gaining" registrar requests a transfer from the "losing" (aka current) registrar. The
losing registrar has a "transfer" time period to respond (by default five days) after which the
transfer is automatically approved. Within that window, this flow allows the losing client to
explicitly approve the transfer request, which then becomes effective immediately.
The "gaining" registrar requests a transfer from the "losing" (aka current)
registrar. The losing registrar has a "transfer" time period to respond (by
default five days) after which the transfer is automatically approved. Within
that window, this flow allows the losing client to explicitly approve the
transfer request, which then becomes effective immediately.
### Errors
@ -144,10 +154,12 @@ explicitly approve the transfer request, which then becomes effective immediatel
An EPP flow that returns information about a contact.
The response includes the contact's postal info, phone numbers, emails, the authInfo which can
be used to request a transfer and the details of the contact's most recent transfer if it has
ever been transferred. Any registrar can see any contact's information, but the authInfo is only
visible to the registrar that owns the contact or to a registrar that already supplied it.
The response includes the contact's postal info, phone numbers, emails, the
authInfo which can be used to request a transfer and the details of the
contact's most recent transfer if it has ever been transferred. Any registrar
can see any contact's information, but the authInfo is only visible to the
registrar that owns the contact or to a registrar that already supplied it.
### Errors
@ -160,11 +172,13 @@ visible to the registrar that owns the contact or to a registrar that already su
An EPP flow that deletes a contact.
Contacts that are in use by any domain cannot be deleted. The flow may return immediately if a
quick smoke check determines that deletion is impossible due to an existing reference. However, a
successful delete will always be asynchronous, as all existing domains must be checked for
references to the host before the deletion is allowed to proceed. A poll message will be written
with the success or failure message when the process is complete.
Contacts that are in use by any domain cannot be deleted. The flow may return
immediately if a quick smoke check determines that deletion is impossible due to
an existing reference. However, a successful delete will always be asynchronous,
as all existing domains must be checked for references to the host before the
deletion is allowed to proceed. A poll message will be written with the success
or failure message when the process is complete.
### Errors
@ -183,6 +197,7 @@ with the success or failure message when the process is complete.
An EPP flow that creates a new contact.
### Errors
* 2005
@ -200,6 +215,7 @@ An EPP flow that checks whether a contact can be provisioned.
This flows can check the existence of multiple contacts simultaneously.
### Errors
* 2306
@ -211,29 +227,33 @@ This flows can check the existence of multiple contacts simultaneously.
An EPP flow that updates a domain.
Updates can change contacts, nameservers and delegation signer data of a domain. Updates
cannot change the domain's name.
Updates can change contacts, nameservers and delegation signer data of a domain.
Updates cannot change the domain's name.
Some status values (those of the form "serverSomethingProhibited") can only be applied by the
superuser. As such, adding or removing these statuses incurs a billing event. There will be only
one charge per update, even if several such statuses are updated at once.
Some status values (those of the form "serverSomethingProhibited") can only be
applied by the superuser. As such, adding or removing these statuses incurs a
billing event. There will be only one charge per update, even if several such
statuses are updated at once.
If a domain was created during the sunrise or landrush phases of a TLD, is still
within the sunrushAddGracePeriod and has not yet been delegated in DNS, then it
will not yet have been billed for. Any update that causes the name to be
delegated (such * as adding nameservers or removing a hold status) will cause
the domain to convert to a normal create and be billed for accordingly.
If a domain was created during the sunrise or landrush phases of a TLD, is still within the
sunrushAddGracePeriod and has not yet been delegated in DNS, then it will not yet have been
billed for. Any update that causes the name to be delegated (such * as adding nameservers or
removing a hold status) will cause the domain to convert to a normal create and be billed for
accordingly.
### Errors
* 2003
* At least one of 'add' or 'rem' is required on a secDNS update.
* Fees must be explicitly acknowledged when performing an update which is not free.
* Fees must be explicitly acknowledged when performing an update which is
not free.
* Admin contact is required.
* Technical contact is required.
* 2004
* The specified status value cannot be set by clients.
* The fees passed in the transform command do not match the fees that will be charged.
* The fees passed in the transform command do not match the fees that will
be charged.
* 2102
* Changing 'maxSigLife' is not supported.
* The 'urgent' attribute is not supported.
@ -247,7 +267,8 @@ accordingly.
* Resource with this id does not exist.
* Resource linked to this domain does not exist.
* 2304
* This resource has clientUpdateProhibited on it, and the update does not clear that status.
* This resource has clientUpdateProhibited on it, and the update does not
clear that status.
* Resource status prohibits this operation.
* Linked resource in pending delete prohibits operation.
* Nameservers are not whitelisted for this TLD.
@ -267,30 +288,36 @@ accordingly.
An EPP flow that requests a transfer on a domain.
The "gaining" registrar requests a transfer from the "losing" (aka current) registrar. The
losing registrar has a "transfer" time period to respond (by default five days) after which the
transfer is automatically approved. Within that window, the transfer might be approved explicitly
by the losing registrar or rejected, and the gaining registrar can also cancel the transfer
request.
The "gaining" registrar requests a transfer from the "losing" (aka current)
registrar. The losing registrar has a "transfer" time period to respond (by
default five days) after which the transfer is automatically approved. Within
that window, the transfer might be approved explicitly by the losing registrar
or rejected, and the gaining registrar can also cancel the transfer request.
When a transfer is requested, poll messages and billing events are saved to
Datastore with timestamps such that they only become active when the
server-approval period passes. Keys to these speculative objects are saved in
the domain's transfer data, and on explicit approval, rejection or cancellation
of the request, they will be deleted (and in the approval case, replaced with
new ones with the correct approval time).
When a transfer is requested, poll messages and billing events are saved to Datastore with
timestamps such that they only become active when the server-approval period passes. Keys to
these speculative objects are saved in the domain's transfer data, and on explicit approval,
rejection or cancellation of the request, they will be deleted (and in the approval case,
replaced with new ones with the correct approval time).
### Errors
* 2002
* Registrar already sponsors the object of this transfer request.
* 2003
* Fees must be explicitly acknowledged when performing any operations on a premium name.
* Fees must be explicitly acknowledged when performing any operations on a
premium name.
* 2004
* The fees passed in the transform command do not match the fees that will be charged.
* The fees passed in the transform command do not match the fees that will
be charged.
* 2005
* The requested fee is expressed in a scale that is invalid for the given currency.
* The requested fee is expressed in a scale that is invalid for the given
currency.
* 2102
* The 'grace-period', 'applied' and 'refundable' fields are disallowed by server policy.
* The 'grace-period', 'applied' and 'refundable' fields are disallowed by
server policy.
* 2201
* Authorization info is required to request a transfer.
* Registrar is not authorized to access this TLD.
@ -302,8 +329,8 @@ replaced with new ones with the correct approval time).
* Resource with this id does not exist.
* 2304
* Resource status prohibits this operation.
* The requested domain name is on the premium price list, and this registrar has blocked premium
registrations.
* The requested domain name is on the premium price list, and this
registrar has blocked premium registrations.
* 2306
* Periods for domain registrations must be specified in years.
* The requested fees cannot be provided in the requested currency.
@ -314,14 +341,15 @@ registrations.
An EPP flow that rejects a pending transfer on a domain.
The "gaining" registrar requests a transfer from the "losing" (aka current) registrar. The
losing registrar has a "transfer" time period to respond (by default five days) after which the
transfer is automatically approved. Within that window, this flow allows the losing client to
reject the transfer request.
The "gaining" registrar requests a transfer from the "losing" (aka current)
registrar. The losing registrar has a "transfer" time period to respond (by
default five days) after which the transfer is automatically approved. Within
that window, this flow allows the losing client to reject the transfer request.
When the transfer was requested, poll messages and billing events were saved to
Datastore with timestamps such that they only would become active when the
transfer period passed. In this flow, those speculative objects are deleted.
When the transfer was requested, poll messages and billing events were saved to Datastore with
timestamps such that they only would become active when the transfer period passed. In this flow,
those speculative objects are deleted.
### Errors
@ -341,12 +369,14 @@ those speculative objects are deleted.
An EPP flow that queries a pending transfer on a domain.
The "gaining" registrar requests a transfer from the "losing" (aka current) registrar. The
losing registrar has a "transfer" time period to respond (by default five days) after which the
transfer is automatically approved. This flow can be used by the gaining or losing registrars
(or anyone with the correct authId) to see the status of a transfer, which may still be pending
or may have been approved, rejected, cancelled or implicitly approved by virtue of the transfer
period expiring.
The "gaining" registrar requests a transfer from the "losing" (aka current)
registrar. The losing registrar has a "transfer" time period to respond (by
default five days) after which the transfer is automatically approved. This flow
can be used by the gaining or losing registrars (or anyone with the correct
authId) to see the status of a transfer, which may still be pending or may have
been approved, rejected, cancelled or implicitly approved by virtue of the
transfer period expiring.
### Errors
@ -365,14 +395,16 @@ period expiring.
An EPP flow that cancels a pending transfer on a domain.
The "gaining" registrar requests a transfer from the "losing" (aka current) registrar. The
losing registrar has a "transfer" time period to respond (by default five days) after which the
transfer is automatically approved. Within that window, this flow allows the gaining client to
withdraw the transfer request.
The "gaining" registrar requests a transfer from the "losing" (aka current)
registrar. The losing registrar has a "transfer" time period to respond (by
default five days) after which the transfer is automatically approved. Within
that window, this flow allows the gaining client to withdraw the transfer
request.
When the transfer was requested, poll messages and billing events were saved to
Datastore with timestamps such that they only would become active when the
transfer period passed. In this flow, those speculative objects are deleted.
When the transfer was requested, poll messages and billing events were saved to Datastore with
timestamps such that they only would become active when the transfer period passed. In this flow,
those speculative objects are deleted.
### Errors
@ -392,14 +424,17 @@ those speculative objects are deleted.
An EPP flow that approves a pending transfer on a domain.
The "gaining" registrar requests a transfer from the "losing" (aka current) registrar. The
losing registrar has a "transfer" time period to respond (by default five days) after which the
transfer is automatically approved. Within that window, this flow allows the losing client to
explicitly approve the transfer request, which then becomes effective immediately.
The "gaining" registrar requests a transfer from the "losing" (aka current)
registrar. The losing registrar has a "transfer" time period to respond (by
default five days) after which the transfer is automatically approved. Within
that window, this flow allows the losing client to explicitly approve the
transfer request, which then becomes effective immediately.
When the transfer was requested, poll messages and billing events were saved to
Datastore with timestamps such that they only would become active when the
transfer period passed. In this flow, those speculative objects are deleted and
replaced with new ones with the correct approval time.
When the transfer was requested, poll messages and billing events were saved to Datastore with
timestamps such that they only would become active when the transfer period passed. In this flow,
those speculative objects are deleted and replaced with new ones with the correct approval time.
### Errors
@ -417,37 +452,45 @@ those speculative objects are deleted and replaced with new ones with the correc
### Description
An EPP flow that requests that a domain in the redemption grace period be restored.
An EPP flow that requests that a domain in the redemption grace period be
restored.
When a domain is deleted it is removed from DNS immediately and marked as pending delete, but
is not actually soft deleted. There is a period (by default 30 days) during which it can be
restored by the original owner. When that period expires there is a second period (by default 5
days) during which the domain cannot be restored. After that period anyone can re-register this
name.
When a domain is deleted it is removed from DNS immediately and marked as
pending delete, but is not actually soft deleted. There is a period (by default
30 days) during which it can be restored by the original owner. When that period
expires there is a second period (by default 5 days) during which the domain
cannot be restored. After that period anyone can re-register this name.
This flow is called a restore "request" because technically it is only supposed to signal that
the registrar requests the restore, which the registry can choose to process or not based on a
restore report that is submitted through an out of band process and details the request. However,
in practice this flow does the restore immediately. This is allowable because all of the fields
on a restore report are optional or have default values, and so by policy when the request comes
in we consider it to have been accompanied by a default-initialized report which we auto-approve.
This flow is called a restore "request" because technically it is only supposed
to signal that the registrar requests the restore, which the registry can choose
to process or not based on a restore report that is submitted through an out of
band process and details the request. However, in practice this flow does the
restore immediately. This is allowable because all of the fields on a restore
report are optional or have default values, and so by policy when the request
comes in we consider it to have been accompanied by a default-initialized report
which we auto-approve.
Restores cost a fixed restore fee plus a one year renewal fee for the domain.
The domain is restored to a single year expiration starting at the restore time,
regardless of what the original expiration time was.
Restores cost a fixed restore fee plus a one year renewal fee for the domain. The domain is
restored to a single year expiration starting at the restore time, regardless of what the
original expiration time was.
### Errors
* 2002
* Restore command cannot have other changes specified.
* 2003
* Fees must be explicitly acknowledged when performing any operations on a premium name.
* Fees must be explicitly acknowledged when performing any operations on a
premium name.
* 2004
* The fees passed in the transform command do not match the fees that will be charged.
* The fees passed in the transform command do not match the fees that will
be charged.
* 2005
* The requested fee is expressed in a scale that is invalid for the given currency.
* The requested fee is expressed in a scale that is invalid for the given
currency.
* 2102
* The 'grace-period', 'applied' and 'refundable' fields are disallowed by server policy.
* The 'grace-period', 'applied' and 'refundable' fields are disallowed by
server policy.
* 2103
* Specified extension is not implemented.
* 2201
@ -457,8 +500,8 @@ original expiration time was.
* Resource with this id does not exist.
* 2304
* Requested domain is reserved.
* The requested domain name is on the premium price list, and this registrar has blocked premium
registrations.
* The requested domain name is on the premium price list, and this
registrar has blocked premium registrations.
* Domain is not eligible for restore.
* 2306
* The requested fees cannot be provided in the requested currency.
@ -469,33 +512,39 @@ registrations.
An EPP flow that renews a domain.
Registrars can use this flow to manually extend the length of a registration, instead of
relying on domain auto-renewal (where the registry performs an automatic one-year renewal at the
instant a domain would expire).
Registrars can use this flow to manually extend the length of a registration,
instead of relying on domain auto-renewal (where the registry performs an
automatic one-year renewal at the instant a domain would expire).
ICANN prohibits any registration from being longer than ten years so if the
request would result in a registration greater than ten years long it will fail.
In practice this means it's impossible to request a ten year renewal, since that
will always cause the new registration to be longer than 10 years unless it
comes in at the exact millisecond that the domain would have expired.
ICANN prohibits any registration from being longer than ten years so if the request would
result in a registration greater than ten years long it will fail. In practice this means it's
impossible to request a ten year renewal, since that will always cause the new registration to be
longer than 10 years unless it comes in at the exact millisecond that the domain would have
expired.
### Errors
* 2003
* Fees must be explicitly acknowledged when performing any operations on a premium name.
* Fees must be explicitly acknowledged when performing any operations on a
premium name.
* 2004
* The fees passed in the transform command do not match the fees that will be charged.
* The fees passed in the transform command do not match the fees that will
be charged.
* New registration period exceeds maximum number of years.
* The current expiration date is incorrect.
* 2005
* The requested fee is expressed in a scale that is invalid for the given currency.
* The requested fee is expressed in a scale that is invalid for the given
currency.
* 2102
* The 'grace-period', 'applied' and 'refundable' fields are disallowed by server policy.
* The 'grace-period', 'applied' and 'refundable' fields are disallowed by
server policy.
* 2201
* The specified resource belongs to another client.
* Registrar is not authorized to access this TLD.
* 2300
* The domain has a pending transfer on it and so can't be explicitly renewed.
* The domain has a pending transfer on it and so can't be explicitly
renewed.
* 2303
* Resource with this id does not exist.
* 2304
@ -510,9 +559,11 @@ expired.
An EPP flow that returns information about a domain.
The registrar that owns the domain, and any registrar presenting a valid authInfo for the
domain, will get a rich result with all of the domain's fields. All other requests will be
answered with a minimal result containing only basic information about the domain.
The registrar that owns the domain, and any registrar presenting a valid
authInfo for the domain, will get a rich result with all of the domain's fields.
All other requests will be answered with a minimal result containing only basic
information about the domain.
### Errors
@ -532,6 +583,7 @@ answered with a minimal result containing only basic information about the domai
An EPP flow that deletes a domain.
### Errors
* 2002
@ -553,6 +605,7 @@ An EPP flow that deletes a domain.
An EPP flow that creates a new domain resource.
### Errors
* 2002
@ -560,24 +613,29 @@ An EPP flow that creates a new domain resource.
* Signed marks are not accepted in the current registry phase.
* The current registry phase does not allow for general registrations.
* 2003
* Fees must be explicitly acknowledged when performing any operations on a premium name.
* Fees must be explicitly acknowledged when performing any operations on a
premium name.
* Admin contact is required.
* Registrant is required.
* Technical contact is required.
* 2004
* The acceptance time specified in the claim notice is more than 48 hours in the past.
* The acceptance time specified in the claim notice is more than 48 hours
in the past.
* The expiration time specified in the claim notice has elapsed.
* The checksum in the specified TCNID does not validate.
* The fees passed in the transform command do not match the fees that will be charged.
* The fees passed in the transform command do not match the fees that will
be charged.
* Domain label is not allowed by IDN table.
* Domain name is under tld which doesn't exist.
* 2005
* The specified TCNID is invalid.
* Domain name must have exactly one part above the tld.
* The requested fee is expressed in a scale that is invalid for the given currency.
* The requested fee is expressed in a scale that is invalid for the given
currency.
* 2102
* The 'maxSigLife' setting is not supported.
* The 'grace-period', 'applied' and 'refundable' fields are disallowed by server policy.
* The 'grace-period', 'applied' and 'refundable' fields are disallowed by
server policy.
* 2103
* Specified extension is not implemented.
* 2201
@ -595,8 +653,8 @@ An EPP flow that creates a new domain resource.
* Linked resource in pending delete prohibits operation.
* Nameservers are not whitelisted for this TLD.
* Nameservers not specified for this TLD with whitelist.
* The requested domain name is on the premium price list, and this registrar has blocked premium
registrations.
* The requested domain name is on the premium price list, and this
registrar has blocked premium registrations.
* Registrant is not whitelisted for this TLD.
* There is an open application for this domain.
* 2306
@ -605,7 +663,8 @@ registrations.
* Domain names can only contain a-z, 0-9, '.' and '-'.
* Periods for domain registrations must be specified in years.
* The requested fees cannot be provided in the requested currency.
* Non-IDN domain names cannot contain hyphens in the third or fourth position.
* Non-IDN domain names cannot contain hyphens in the third or fourth
position.
* Domain labels cannot be longer than 63 characters.
* More than one contact for a given role is not allowed.
* No part of a domain name can be empty.
@ -622,7 +681,9 @@ registrations.
An EPP flow that checks whether a domain can be provisioned.
This flow also supports the EPP fee extension and can return pricing information.
This flow also supports the EPP fee extension and can return pricing
information.
### Errors
@ -640,7 +701,8 @@ This flow also supports the EPP fee extension and can return pricing information
* Domain names can only contain a-z, 0-9, '.' and '-'.
* Periods for domain registrations must be specified in years.
* The requested fees cannot be provided in the requested currency.
* Non-IDN domain names cannot contain hyphens in the third or fourth position.
* Non-IDN domain names cannot contain hyphens in the third or fourth
position.
* Domain labels cannot be longer than 63 characters.
* No part of a domain name can be empty.
* Fee checks for command phases and subphases are not supported.
@ -649,7 +711,8 @@ This flow also supports the EPP fee extension and can return pricing information
* Restores always renew a domain for one year.
* Domain labels cannot end with a dash.
* Unknown fee command name.
* By server policy, fee check names must be listed in the availability check.
* By server policy, fee check names must be listed in the availability
check.
## DomainApplicationUpdateFlow
@ -657,8 +720,9 @@ This flow also supports the EPP fee extension and can return pricing information
An EPP flow that updates a domain application.
Updates can change contacts, nameservers and delegation signer data of an application. Updates
cannot change the domain name that is being applied for.
Updates can change contacts, nameservers and delegation signer data of an
application. Updates cannot change the domain name that is being applied for.
### Errors
@ -680,7 +744,8 @@ cannot change the domain name that is being applied for.
* Resource with this id does not exist.
* Resource linked to this domain does not exist.
* 2304
* This resource has clientUpdateProhibited on it, and the update does not clear that status.
* This resource has clientUpdateProhibited on it, and the update does not
clear that status.
* Resource status prohibits this operation.
* Nameservers are not whitelisted for this TLD.
* Registrant is not whitelisted for this TLD.
@ -699,8 +764,9 @@ cannot change the domain name that is being applied for.
An EPP flow that returns information about a domain application.
Only the registrar that owns the application can see its info. The flow can optionally include
delegated hosts in its response.
Only the registrar that owns the application can see its info. The flow can
optionally include delegated hosts in its response.
### Errors
@ -720,6 +786,7 @@ delegated hosts in its response.
An EPP flow that deletes a domain application.
### Errors
* 2002
@ -735,7 +802,8 @@ An EPP flow that deletes a domain application.
* A sunrise application cannot be deleted during landrush.
* 2306
* Application referenced does not match specified domain name.
* Declared launch extension phase does not match the current registry phase.
* Declared launch extension phase does not match the current registry
phase.
## DomainApplicationCreateFlow
@ -743,6 +811,7 @@ An EPP flow that deletes a domain application.
An EPP flow that creates a new application for a domain resource.
### Errors
* 2002
@ -751,24 +820,29 @@ An EPP flow that creates a new application for a domain resource.
* Command is not allowed in the current registry phase.
* 2003
* Landrush applications are disallowed during sunrise.
* Fees must be explicitly acknowledged when performing any operations on a premium name.
* Fees must be explicitly acknowledged when performing any operations on a
premium name.
* The provided mark does not match the desired domain label.
* 2004
* The acceptance time specified in the claim notice is more than 48 hours in the past.
* The acceptance time specified in the claim notice is more than 48 hours
in the past.
* The expiration time specified in the claim notice has elapsed.
* The checksum in the specified TCNID does not validate.
* The fees passed in the transform command do not match the fees that will be charged.
* The fees passed in the transform command do not match the fees that will
be charged.
* Domain label is not allowed by IDN table.
* Domain name is under tld which doesn't exist.
* 2005
* The specified TCNID is invalid.
* Domain name must have exactly one part above the tld.
* The requested fee is expressed in a scale that is invalid for the given currency.
* The requested fee is expressed in a scale that is invalid for the given
currency.
* Signed mark data is improperly encoded.
* Error while parsing encoded signed mark data.
* 2102
* The 'maxSigLife' setting is not supported.
* The 'grace-period', 'applied' and 'refundable' fields are disallowed by server policy.
* The 'grace-period', 'applied' and 'refundable' fields are disallowed by
server policy.
* 2103
* Specified extension is not implemented.
* 2201
@ -787,8 +861,8 @@ An EPP flow that creates a new application for a domain resource.
* Requested domain is reserved.
* Nameservers are not whitelisted for this TLD.
* Nameservers not specified for this TLD with whitelist.
* The requested domain name is on the premium price list, and this registrar has blocked premium
registrations.
* The requested domain name is on the premium price list, and this
registrar has blocked premium registrations.
* Registrant is not whitelisted for this TLD.
* 2306
* The specified trademark validator is not supported.
@ -797,12 +871,14 @@ registrations.
* Periods for domain registrations must be specified in years.
* Encoded signed marks must use base64 encoding.
* The requested fees cannot be provided in the requested currency.
* Non-IDN domain names cannot contain hyphens in the third or fourth position.
* Non-IDN domain names cannot contain hyphens in the third or fourth
position.
* Domain labels cannot be longer than 63 characters.
* More than one contact for a given role is not allowed.
* No part of a domain name can be empty.
* Domain name starts with xn-- but is not a valid IDN.
* Declared launch extension phase does not match the current registry phase.
* Declared launch extension phase does not match the current registry
phase.
* Domain labels cannot begin with a dash.
* Missing type attribute for contact.
* Signed marks must be encoded.
@ -824,6 +900,7 @@ registrations.
An EPP flow that allocates a new domain resource from a domain application.
### Errors
* 2201
@ -842,6 +919,7 @@ An EPP flow that allocates a new domain resource from a domain application.
An EPP flow that checks whether strings are trademarked.
### Errors
* 2002
@ -861,15 +939,17 @@ An EPP flow that checks whether strings are trademarked.
An EPP flow that updates a host.
Hosts can be "external", or "internal" (also known as "in bailiwick"). Internal hosts are
those that are under a top level domain within this registry, and external hosts are all other
hosts. Internal hosts must have at least one IP address associated with them, whereas external
hosts cannot have any.
Hosts can be "external", or "internal" (also known as "in bailiwick"). Internal
hosts are those that are under a top level domain within this registry, and
external hosts are all other hosts. Internal hosts must have at least one IP
address associated with them, whereas external hosts cannot have any.
This flow allows changing a host name, and adding or removing IP addresses to
hosts. When a host is renamed from internal to external all IP addresses must be
simultaneously removed, and when it is renamed from external to internal at
least one must be added. If the host is renamed or IP addresses are added, tasks
are enqueued to update DNS accordingly.
This flow allows changing a host name, and adding or removing IP addresses to hosts. When
a host is renamed from internal to external all IP addresses must be simultaneously removed, and
when it is renamed from external to internal at least one must be added. If the host is renamed
or IP addresses are added, tasks are enqueued to update DNS accordingly.
### Errors
@ -878,7 +958,8 @@ or IP addresses are added, tasks are enqueued to update DNS accordingly.
* 2004
* The specified status value cannot be set by clients.
* Cannot add IP addresses to an external host.
* Host rename from subordinate to external must also remove all IP addresses.
* Host rename from subordinate to external must also remove all IP
addresses.
* 2005
* Invalid host name.
* 2201
@ -889,7 +970,8 @@ or IP addresses are added, tasks are enqueued to update DNS accordingly.
* Resource with this id does not exist.
* Superordinate domain for this hostname does not exist.
* 2304
* This resource has clientUpdateProhibited on it, and the update does not clear that status.
* This resource has clientUpdateProhibited on it, and the update does not
clear that status.
* Resource status prohibits this operation.
* Cannot remove all IP addresses from a subordinate host.
* 2306
@ -901,8 +983,10 @@ or IP addresses are added, tasks are enqueued to update DNS accordingly.
An EPP flow that returns information about a host.
The returned information included IP addresses, if any, and details of the host's most recent
transfer if it has ever been transferred. Any registrar can see the information for any host.
The returned information included IP addresses, if any, and details of the
host's most recent transfer if it has ever been transferred. Any registrar can
see the information for any host.
### Errors
@ -915,11 +999,13 @@ transfer if it has ever been transferred. Any registrar can see the information
An EPP flow that deletes a host.
Hosts that are in use by any domain cannot be deleted. The flow may return immediately if a
quick smoke check determines that deletion is impossible due to an existing reference. However, a
successful delete will always be asynchronous, as all existing domains must be checked for
references to the host before the deletion is allowed to proceed. A poll message will be written
with the success or failure message when the process is complete.
Hosts that are in use by any domain cannot be deleted. The flow may return
immediately if a quick smoke check determines that deletion is impossible due to
an existing reference. However, a successful delete will always be asynchronous,
as all existing domains must be checked for references to the host before the
deletion is allowed to proceed. A poll message will be written with the success
or failure message when the process is complete.
### Errors
@ -938,11 +1024,12 @@ with the success or failure message when the process is complete.
An EPP flow that creates a new host.
Hosts can be "external", or "internal" (also known as "in bailiwick"). Internal hosts are
those that are under a top level domain within this registry, and external hosts are all other
hosts. Internal hosts must have at least one ip address associated with them, whereas external
hosts cannot have any. This flow allows creating a host name, and if necessary enqueues tasks to
update DNS.
Hosts can be "external", or "internal" (also known as "in bailiwick"). Internal
hosts are those that are under a top level domain within this registry, and
external hosts are all other hosts. Internal hosts must have at least one ip
address associated with them, whereas external hosts cannot have any. This flow
allows creating a host name, and if necessary enqueues tasks to update DNS.
### Errors
@ -969,6 +1056,7 @@ An EPP flow that checks whether a host can be provisioned.
This flows can check the existence of multiple hosts simultaneously.
### Errors
* 2306
@ -980,11 +1068,13 @@ This flows can check the existence of multiple hosts simultaneously.
An EPP flow for requesting {@link PollMessage}s.
This flow uses an eventually consistent Datastore query to return the oldest poll message for
the registrar, as well as the total number of pending messages. Note that poll messages whose
event time is in the future (i.e. they are speculative and could still be changed or rescinded)
are ignored. The externally visible id for the poll message that the registrar sees is generated
by {@link PollMessageExternalKeyConverter}.
This flow uses an eventually consistent Datastore query to return the oldest
poll message for the registrar, as well as the total number of pending messages.
Note that poll messages whose event time is in the future (i.e. they are
speculative and could still be changed or rescinded) are ignored. The externally
visible id for the poll message that the registrar sees is generated by {@link
PollMessageExternalKeyConverter}.
### Errors
@ -998,9 +1088,10 @@ by {@link PollMessageExternalKeyConverter}.
An EPP flow for acknowledging {@link PollMessage}s.
Registrars refer to poll messages using an externally visible id generated by
{@link PollMessageExternalKeyConverter}. One-time poll messages are deleted from Datastore once
they are ACKed, whereas autorenew poll messages are simply marked as read, and won't be delivered
again until the next year of their recurrence.
{@link PollMessageExternalKeyConverter}. One-time poll messages are deleted from
Datastore once they are ACKed, whereas autorenew poll messages are simply marked
as read, and won't be delivered again until the next year of their recurrence.
### Errors
@ -1019,6 +1110,7 @@ again until the next year of their recurrence.
An EPP flow for logout.
### Errors
* 2002
@ -1030,6 +1122,7 @@ An EPP flow for logout.
An EPP flow for login.
### Errors
* 2002
@ -1064,6 +1157,7 @@ An EPP flow for login.
A flow for an Epp "hello".
### Errors