registrations

Overview

Name	registrations
Type	Resource
Id	google.domains.registrations

Fields

Name	Datatype	Description
name	string	Output only. Name of the Registration resource, in the format projects/*/locations/*/registrations/.
domainName	string	Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
state	string	Output only. The state of the Registration
contactSettings	object	Defines the contact information associated with a Registration. ICANN requires all domain names to have associated contact information. The registrant_contact is considered the domain's legal owner, and often the other contacts are identical.
createTime	string	Output only. The creation timestamp of the Registration resource.
pendingContactSettings	object	Defines the contact information associated with a Registration. ICANN requires all domain names to have associated contact information. The registrant_contact is considered the domain's legal owner, and often the other contacts are identical.
issues	array	Output only. The set of issues with the Registration that require attention.
expireTime	string	Output only. The expiration timestamp of the Registration.
transferFailureReason	string	Output only. The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.
dnsSettings	object	Defines the DNS configuration of a Registration, including name servers, DNSSEC, and glue records.
supportedPrivacy	array	Output only. Set of options for the contact_settings.privacy field that this Registration supports.
managementSettings	object	Defines renewal, billing, and transfer settings for a Registration.
registerFailureReason	string	Output only. The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state.
labels	object	Set of labels associated with the Registration.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, projectsId, registrationsId	Gets the details of a Registration resource.
list	SELECT	locationsId, projectsId	Lists the Registration resources in a project.
delete	DELETE	locationsId, projectsId, registrationsId	Deletes a Registration resource. This method works on any Registration resource using Subscription or Commitment billing, provided that the resource was created at least 1 day in the past. For Registration resources using Monthly billing, this method works if: state is EXPORTED with expire_time in the past state is REGISTRATION_FAILED * state is TRANSFER_FAILED When an active registration is successfully deleted, you can continue to use the domain in Google Domains until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.
_list	EXEC	locationsId, projectsId	Lists the Registration resources in a project.
configure_contact_settings	EXEC	locationsId, projectsId, registrationsId	Updates a Registration's contact settings. Some changes require confirmation by the domain's registrant contact .
configure_dns_settings	EXEC	locationsId, projectsId, registrationsId	Updates a Registration's DNS settings.
configure_management_settings	EXEC	locationsId, projectsId, registrationsId	Updates a Registration's management settings.
export	EXEC	locationsId, projectsId, registrationsId	Exports a Registration resource, such that it is no longer managed by Cloud Domains. When an active domain is successfully exported, you can continue to use the domain in Google Domains until it expires. The calling user becomes the domain's sole owner in Google Domains, and permissions for the domain are subsequently managed there. The domain does not renew automatically unless the new owner sets up billing in Google Domains.
import	EXEC	locationsId, projectsId	Imports a domain name from Google Domains for use in Cloud Domains. To transfer a domain from another registrar, use the TransferDomain method instead. Since individual users can own domains in Google Domains, the calling user must have ownership permission on the domain.
patch	EXEC	locationsId, projectsId, registrationsId	Updates select fields of a Registration resource, notably labels. To update other fields, use the appropriate custom update method: To update management settings, see ConfigureManagementSettings To update DNS configuration, see ConfigureDnsSettings * To update contact information, see ConfigureContactSettings
register	EXEC	locationsId, projectsId	Registers a new domain name and creates a corresponding Registration resource. Call RetrieveRegisterParameters first to check availability of the domain name and determine parameters like price that are needed to build a call to this method. A successful call creates a Registration resource in state REGISTRATION_PENDING, which resolves to ACTIVE within 1-2 minutes, indicating that the domain was successfully registered. If the resource ends up in state REGISTRATION_FAILED, it indicates that the domain was not registered successfully, and you can safely delete the resource and retry registration.
reset_authorization_code	EXEC	locationsId, projectsId, registrationsId	Resets the authorization code of the Registration to a new random string. You can call this method only after 60 days have elapsed since the initial domain registration.
search_domains	EXEC	locationsId, projectsId	Searches for available domain names similar to the provided query. Availability results from this method are approximate; call RetrieveRegisterParameters on a domain before registering to confirm availability.
transfer	EXEC	locationsId, projectsId	Transfers a domain name from another registrar to Cloud Domains. For domains already managed by Google Domains, use ImportDomain instead. Before calling this method, go to the domain's current registrar to unlock the domain for transfer and retrieve the domain's transfer authorization code. Then call RetrieveTransferParameters to confirm that the domain is unlocked and to get values needed to build a call to this method. A successful call creates a Registration resource in state TRANSFER_PENDING. It can take several days to complete the transfer process. The registrant can often speed up this process by approving the transfer through the current registrar, either by clicking a link in an email from the registrar or by visiting the registrar's website. A few minutes after transfer approval, the resource transitions to state ACTIVE, indicating that the transfer was successful. If the transfer is rejected or the request expires without being approved, the resource can end up in state TRANSFER_FAILED. If transfer fails, you can safely delete the resource and retry the transfer.