Method: projects.locations.registrations.list

Lists the Registration resources in a project.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The project and location from which to list Registrations, specified in the format projects/*/locations/*.

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

  • 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.

filter

string

Filter expression to restrict the Registrations returned.

The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, a boolean, or an enum value. The comparison operator should be one of =, !=, >, <, >=, <=, or : for prefix or wildcard matches.

For example, to filter to a specific domain name, use an expression like domainName="example.com". You can also check for the existence of a field; for example, to find domains using custom DNS settings, use an expression like dnsSettings.customDns:*.

You can also create compound filters by combining expressions with the AND and OR operators. For example, to find domains that are suspended or have specific issues flagged, use an expression like (state=SUSPENDED) OR (issue:*).

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.list method.

JSON representation
{
  "registrations": [
    {
      object (Registration)
    }
  ],
  "nextPageToken": string
}
Fields
registrations[]

object (Registration)

A list of Registrations.

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.