registrations

Creates, updates, deletes, gets or lists a registrations resource.

Overview

Name	registrations
Type	Resource
Id	google.domains.registrations

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Name of the Registration resource, in the format projects/*/locations/*/registrations/.
contactSettings	object	Required. Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method. (id: ContactSettings)
createTime	string (google-datetime)	Output only. The creation timestamp of the Registration resource.
dnsSettings	object	Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method. (id: DnsSettings)
domainName	string	Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
domainProperties	array	Output only. Special properties of the domain.
expireTime	string (google-datetime)	Output only. The expiration timestamp of the Registration.
issues	array	Output only. The set of issues with the Registration that require attention.
labels	object	Set of labels associated with the Registration.
managementSettings	object	Settings for management of the Registration, including renewal, billing, and transfer. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureManagementSettings method. (id: ManagementSettings)
pendingContactSettings	object	Output only. Pending contact settings for the Registration. Updates to the contact_settings field that change its registrant_contact or privacy fields require email confirmation by the registrant_contact before taking effect. This field is set only if there are pending updates to the contact_settings that have not been confirmed. To confirm the changes, the registrant_contact must follow the instructions in the email they receive. (id: ContactSettings)
registerFailureReason	string	Output only. The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state.
state	string	Output only. The state of the Registration
supportedPrivacy	array	Output only. Set of options for the contact_settings.privacy field that this Registration supports.
transferFailureReason	string	Output only. Deprecated: For more information, see Cloud Domains feature deprecation. The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.

list

Successful response

Name	Datatype	Description
name	string	Output only. Name of the Registration resource, in the format projects/*/locations/*/registrations/.
contactSettings	object	Required. Settings for contact information linked to the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureContactSettings method. (id: ContactSettings)
createTime	string (google-datetime)	Output only. The creation timestamp of the Registration resource.
dnsSettings	object	Settings controlling the DNS configuration of the Registration. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureDnsSettings method. (id: DnsSettings)
domainName	string	Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.
domainProperties	array	Output only. Special properties of the domain.
expireTime	string (google-datetime)	Output only. The expiration timestamp of the Registration.
issues	array	Output only. The set of issues with the Registration that require attention.
labels	object	Set of labels associated with the Registration.
managementSettings	object	Settings for management of the Registration, including renewal, billing, and transfer. You cannot update these with the UpdateRegistration method. To update these settings, use the ConfigureManagementSettings method. (id: ManagementSettings)
pendingContactSettings	object	Output only. Pending contact settings for the Registration. Updates to the contact_settings field that change its registrant_contact or privacy fields require email confirmation by the registrant_contact before taking effect. This field is set only if there are pending updates to the contact_settings that have not been confirmed. To confirm the changes, the registrant_contact must follow the instructions in the email they receive. (id: ContactSettings)
registerFailureReason	string	Output only. The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state.
state	string	Output only. The state of the Registration
supportedPrivacy	array	Output only. Set of options for the contact_settings.privacy field that this Registration supports.
transferFailureReason	string	Output only. Deprecated: For more information, see Cloud Domains feature deprecation. The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, registrationsId		Gets the details of a Registration resource.
list	select	projectsId, locationsId	pageSize, pageToken, filter	Lists the Registration resources in a project.
patch	update	projectsId, locationsId, registrationsId	updateMask	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
delete	delete	projectsId, locationsId, 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. 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. After January 2024 you will only be able to delete Registration resources when state is one of: EXPORTED, EXPIRED,REGISTRATION_FAILED or TRANSFER_FAILED. See Cloud Domains feature deprecation for more details.
search_domains	exec	projectsId, locationsId	query	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.
register	exec	projectsId, locationsId		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.
transfer	exec	projectsId, locationsId		Deprecated: For more information, see Cloud Domains feature deprecation 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.
import	exec	projectsId, locationsId		Deprecated: For more information, see Cloud Domains feature deprecation 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.
configure_management_settings	exec	projectsId, locationsId, registrationsId		Updates a Registration's management settings.
configure_dns_settings	exec	projectsId, locationsId, registrationsId		Updates a Registration's DNS settings.
configure_contact_settings	exec	projectsId, locationsId, registrationsId		Updates a Registration's contact settings. Some changes require confirmation by the domain's registrant contact . Caution: Please consider carefully any changes to contact privacy settings when changing from REDACTED_CONTACT_DATA to PUBLIC_CONTACT_DATA. There may be a delay in reflecting updates you make to registrant contact information such that any changes you make to contact privacy (including from REDACTED_CONTACT_DATA to PUBLIC_CONTACT_DATA) will be applied without delay but changes to registrant contact information may take a limited time to be publicized. This means that changes to contact privacy from REDACTED_CONTACT_DATA to PUBLIC_CONTACT_DATA may make the previous registrant contact data public until the modified registrant contact details are published.
export	exec	projectsId, locationsId, registrationsId		Deprecated: For more information, see Cloud Domains feature deprecation 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.
reset_authorization_code	exec	projectsId, locationsId, 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. Domains that have the REQUIRE_PUSH_TRANSFER property in the list of domain_properties don't support authorization codes and must use the InitiatePushTransfer method to initiate the process to transfer the domain to a different registrar.
initiate_push_transfer	exec	projectsId, locationsId, registrationsId		Initiates the Push Transfer process to transfer the domain to another registrar. The process might complete instantly or might require confirmation or additional work. Check the emails sent to the email address of the registrant. The process is aborted after a timeout if it's not completed. This method is only supported for domains that have the REQUIRE_PUSH_TRANSFER property in the list of domain_properties. The domain must also be unlocked before it can be transferred to a different registrar. For more information, see Transfer a registered domain to another registrar.
renew_domain	exec	projectsId, locationsId, registrationsId		Renews a recently expired domain. This method can only be called on domains that expired in the previous 30 days. After the renewal, the new expiration time of the domain is one year after the old expiration time and you are charged a yearly_price for the renewal.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
registrationsId	string
filter	string
pageSize	integer (int32)
pageToken	string
query	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets the details of a Registration resource.

SELECT
name,
contactSettings,
createTime,
dnsSettings,
domainName,
domainProperties,
expireTime,
issues,
labels,
managementSettings,
pendingContactSettings,
registerFailureReason,
state,
supportedPrivacy,
transferFailureReason
FROM google.domains.registrations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND registrationsId = '{{ registrationsId }}' -- required;

list

Lists the Registration resources in a project.

SELECT
name,
contactSettings,
createTime,
dnsSettings,
domainName,
domainProperties,
expireTime,
issues,
labels,
managementSettings,
pendingContactSettings,
registerFailureReason,
state,
supportedPrivacy,
transferFailureReason
FROM google.domains.registrations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

UPDATE examples

patch

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

UPDATE google.domains.registrations
SET 
data__domainName = '{{ domainName }}',
data__labels = '{{ labels }}',
data__managementSettings = '{{ managementSettings }}',
data__dnsSettings = '{{ dnsSettings }}',
data__contactSettings = '{{ contactSettings }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND registrationsId = '{{ registrationsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

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. 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. After January 2024 you will only be able to delete Registration resources when state is one of: EXPORTED, EXPIRED,REGISTRATION_FAILED or TRANSFER_FAILED. See Cloud Domains feature deprecation for more details.

DELETE FROM google.domains.registrations
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND registrationsId = '{{ registrationsId }}' --required;

Lifecycle Methods

search_domains

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.

EXEC google.domains.registrations.search_domains 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@query='{{ query }}';

register

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.

EXEC google.domains.registrations.register 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"registration": "{{ registration }}", 
"domainNotices": "{{ domainNotices }}", 
"contactNotices": "{{ contactNotices }}", 
"yearlyPrice": "{{ yearlyPrice }}", 
"validateOnly": {{ validateOnly }}
}';

transfer

Deprecated: For more information, see Cloud Domains feature deprecation 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.

EXEC google.domains.registrations.transfer 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"registration": "{{ registration }}", 
"contactNotices": "{{ contactNotices }}", 
"yearlyPrice": "{{ yearlyPrice }}", 
"authorizationCode": "{{ authorizationCode }}", 
"validateOnly": {{ validateOnly }}
}';

import

Deprecated: For more information, see Cloud Domains feature deprecation 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.

EXEC google.domains.registrations.import 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"domainName": "{{ domainName }}", 
"labels": "{{ labels }}"
}';

configure_management_settings

Updates a Registration's management settings.

EXEC google.domains.registrations.configure_management_settings 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@registrationsId='{{ registrationsId }}' --required 
@@json=
'{
"managementSettings": "{{ managementSettings }}", 
"updateMask": "{{ updateMask }}"
}';

configure_dns_settings

Updates a Registration's DNS settings.

EXEC google.domains.registrations.configure_dns_settings 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@registrationsId='{{ registrationsId }}' --required 
@@json=
'{
"dnsSettings": "{{ dnsSettings }}", 
"updateMask": "{{ updateMask }}", 
"validateOnly": {{ validateOnly }}
}';

configure_contact_settings

Updates a Registration's contact settings. Some changes require confirmation by the domain's registrant contact . Caution: Please consider carefully any changes to contact privacy settings when changing from REDACTED_CONTACT_DATA to PUBLIC_CONTACT_DATA. There may be a delay in reflecting updates you make to registrant contact information such that any changes you make to contact privacy (including from REDACTED_CONTACT_DATA to PUBLIC_CONTACT_DATA) will be applied without delay but changes to registrant contact information may take a limited time to be publicized. This means that changes to contact privacy from REDACTED_CONTACT_DATA to PUBLIC_CONTACT_DATA may make the previous registrant contact data public until the modified registrant contact details are published.

EXEC google.domains.registrations.configure_contact_settings 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@registrationsId='{{ registrationsId }}' --required 
@@json=
'{
"contactSettings": "{{ contactSettings }}", 
"updateMask": "{{ updateMask }}", 
"contactNotices": "{{ contactNotices }}", 
"validateOnly": {{ validateOnly }}
}';

export

Deprecated: For more information, see Cloud Domains feature deprecation 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.

EXEC google.domains.registrations.export 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@registrationsId='{{ registrationsId }}' --required;

reset_authorization_code

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. Domains that have the REQUIRE_PUSH_TRANSFER property in the list of domain_properties don't support authorization codes and must use the InitiatePushTransfer method to initiate the process to transfer the domain to a different registrar.

EXEC google.domains.registrations.reset_authorization_code 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@registrationsId='{{ registrationsId }}' --required;

initiate_push_transfer

Initiates the Push Transfer process to transfer the domain to another registrar. The process might complete instantly or might require confirmation or additional work. Check the emails sent to the email address of the registrant. The process is aborted after a timeout if it's not completed. This method is only supported for domains that have the REQUIRE_PUSH_TRANSFER property in the list of domain_properties. The domain must also be unlocked before it can be transferred to a different registrar. For more information, see Transfer a registered domain to another registrar.

EXEC google.domains.registrations.initiate_push_transfer 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@registrationsId='{{ registrationsId }}' --required 
@@json=
'{
"tag": "{{ tag }}"
}';

renew_domain

Renews a recently expired domain. This method can only be called on domains that expired in the previous 30 days. After the renewal, the new expiration time of the domain is one year after the old expiration time and you are charged a yearly_price for the renewal.

EXEC google.domains.registrations.renew_domain 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@registrationsId='{{ registrationsId }}' --required 
@@json=
'{
"yearlyPrice": "{{ yearlyPrice }}", 
"validateOnly": {{ validateOnly }}
}';