Method: projects.locations.registrations.retrieveImportableDomains

Stay organized with collections Save and categorize content based on your preferences.

Lists domain names from Google Domains that can be imported to Cloud Domains using the registrations.import method.

Since individual users can own domains in Google Domains, the list of domains returned depends on the individual user making the call.

Domains already managed by Cloud Domains are not returned.

HTTP request

GET https://domains.googleapis.com/v1beta1/{location=projects/*/locations/*}/registrations:retrieveImportableDomains

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
location

string

Required. The location. Must be in the format projects/*/locations/*.

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

  • domains.registrations.list

Query parameters

Parameters
pageSize

integer

Maximum number of results to return.

pageToken

string

When set to the nextPageToken from a prior response, provides the next page of results.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response for the registrations.retrieveImportableDomains method.

JSON representation
{
  "domains": [
    {
      object (Domain)
    }
  ],
  "nextPageToken": string
}
Fields
domains[]

object (Domain)

A list of domains that the calling user manages in Google Domains.

nextPageToken

string

When present, there are more results to retrieve. Set pageToken to this value on a subsequent call to get the next page of results.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

Domain

A domain that the calling user manages in Google Domains.

JSON representation
{
  "domainName": string,
  "resourceState": enum (ResourceState),
  "yearlyPrice": {
    object (Money)
  }
}
Fields
domainName

string

The domain name. Unicode domain names are expressed in Punycode format.

resourceState

enum (ResourceState)

The state of this domain as a Registration resource.

yearlyPrice

object (Money)

Price to renew the domain for one year. Only set when resourceState is IMPORTABLE.

ResourceState

Possible states of a domain as a Registration resource.

Enums
RESOURCE_STATE_UNSPECIFIED The assessment is undefined.
IMPORTABLE A Registration resource can be created for this domain by calling registrations.import.
UNSUPPORTED A Registration resource cannot be created for this domain because it is not supported by Cloud Domains; for example, the top-level domain is not supported or the registry charges non-standard pricing for yearly renewals.
SUSPENDED A Registration resource cannot be created for this domain because it is suspended and needs to be resolved with Google Domains.
EXPIRED A Registration resource cannot be created for this domain because it is expired and needs to be renewed with Google Domains.
DELETED A Registration resource cannot be created for this domain because it is deleted, but can be restored with Google Domains.