Method: projects.locations.registrations.configureDnsSettings

Updates a Registration's DNS settings.

HTTP request

POST https://domains.googleapis.com/v1/{registration=projects/*/locations/*/registrations/*}:configureDnsSettings

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
registration

string

Required. The name of the Registration whose DNS settings are being updated, in the format projects/*/locations/*/registrations/*.

Authorization requires the following IAM permission on the specified resource registration:

  • domains.registrations.configureDns

Request body

The request body contains data with the following structure:

JSON representation
{
  "dnsSettings": {
    object (DnsSettings)
  },
  "updateMask": string,
  "validateOnly": boolean
}
Fields
dnsSettings

object (DnsSettings)

Fields of the DnsSettings to update.

updateMask

string (FieldMask format)

Required. The field mask describing which fields to update as a comma-separated list. For example, if only the name servers are being updated for an existing Custom DNS configuration, the updateMask is "customDns.name_servers".

When changing the DNS provider from one type to another, pass the new provider's field name as part of the field mask. For example, when changing from a Google Domains DNS configuration to a Custom DNS configuration, the updateMask is "customDns". //

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

validateOnly

boolean

Validate the request without actually updating the DNS settings.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.