Cloud Domains API (domains:v1)

2024-06-07

3 new methods

Additions

    Methods
  • domains.projects.locations.registrations.retrieveGoogleDomainsForwardingConfig

      Path: v1/{+registration}:retrieveGoogleDomainsForwardingConfig

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:retrieveGoogleDomainsForwardingConfig

      HTTP Method: GET

      Parameters:

        registration

          Description: Required. The name of the `Registration` whose Google Domains forwarding configuration details are being retrieved, in the format `projects/*/locations/*/registrations/*`.

          Pattern: ^projects/[^/]+/locations/[^/]+/registrations/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: registration

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

      Description: Lists the deprecated domain and email forwarding configurations you set up in the deprecated Google Domains UI. The configuration is present only for domains with the `google_domains_redirects_data_available` set to `true` in the `Registration`'s `dns_settings`. A forwarding configuration might not work correctly if required DNS records are not present in the domain's authoritative DNS Zone.

  • domains.projects.locations.registrations.initiatePushTransfer

      Path: v1/{+registration}:initiatePushTransfer

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:initiatePushTransfer

      HTTP Method: POST

      Parameters:

        registration

          Description: Required. The name of the `Registration` for which the push transfer is initiated, in the format `projects/*/locations/*/registrations/*`.

          Pattern: ^projects/[^/]+/locations/[^/]+/registrations/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: registration

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

      Description: 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](https://cloud.google.com/domains/docs/transfer-domain-to-another-registrar).

  • domains.projects.locations.registrations.renewDomain

      Path: v1/{+registration}:renewDomain

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/registrations/{registrationsId}:renewDomain

      HTTP Method: POST

      Parameters:

        registration

          Description: Required. The name of the `Registration` whish is being renewed, in the format `projects/*/locations/*/registrations/*`.

          Pattern: ^projects/[^/]+/locations/[^/]+/registrations/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: registration

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

      Description: 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.