Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132657107.9 KB
projects

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

patch/v1/{+name}

Path parameters

namestring required

Output only. Name of the Registration resource, in the format projects/*/locations/*/registrations/.

Query parameters

updateMaskstring

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the labels are being updated, the update_mask is "labels".

validateOnlyboolean

Optional. If set, validates the request without actually updating the registration.

Request body

issuesstring[]

Output only. The set of issues with the Registration that require attention.

createTimestring google-datetime

Output only. The creation timestamp of the Registration resource.

supportedPrivacystring[]

Output only. Set of options for the contact_settings.privacy field that this Registration supports.

labelsobject

Set of labels associated with the Registration.

domainPropertiesstring[]

Output only. Special properties of the domain.

transferFailureReason'TRANSFER_FAILURE_REASON_UNSPECIFIED' | 'TRANSFER_FAILURE_REASON_UNKNOWN' | 'EMAIL_CONFIRMATION_FAILURE' | 'DOMAIN_NOT_REGISTERED' | 'DOMAIN_HAS_TRANSFER_LOCK' | 'INVALID_AUTHORIZATION_CODE' | 'TRANSFER_CANCELLED' | 'TRANSFER_REJECTED' | 'INVALID_REGISTRANT_EMAIL_ADDRESS' | 'DOMAIN_NOT_ELIGIBLE_FOR_TRANSFER' | 'TRANSFER_ALREADY_PENDING'

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.

expireTimestring google-datetime

Output only. The expiration timestamp of the Registration.

domainNamestring

Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format.

namestring

Output only. Name of the Registration resource, in the format projects/*/locations/*/registrations/.

registerFailureReason'REGISTER_FAILURE_REASON_UNSPECIFIED' | 'REGISTER_FAILURE_REASON_UNKNOWN' | 'DOMAIN_NOT_AVAILABLE' | 'INVALID_CONTACTS'

Output only. The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state.

state'STATE_UNSPECIFIED' | 'REGISTRATION_PENDING' | 'REGISTRATION_FAILED' | 'TRANSFER_PENDING' | 'TRANSFER_FAILED' | 'IMPORT_PENDING' | 'ACTIVE' | 'SUSPENDED' | 'EXPORTED' | 'EXPIRED'

Output only. The state of the Registration

Response

Successful response