Method: projects.locations.registries.list

Lists device registries.

HTTP request

GET https://cloudiot.googleapis.com/v1/{parent=projects/*/locations/*}/registries

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
parent

string

The project and cloud region path. For example, projects/example-project/locations/us-central1.

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

  • cloudiot.registries.list

Query parameters

Parameters
pageSize

number

The maximum number of registries to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested, but if there is a non-empty pageToken, it indicates that more entries are available.

pageToken

string

The value returned by the last ListDeviceRegistriesResponse; indicates that this is a continuation of a prior registries.list call, and that the system should return the next page of data.

Request body

The request body must be empty.

Response body

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

Response for registries.list.

JSON representation
{
  "deviceRegistries": [
    {
      object(DeviceRegistry)
    }
  ],
  "nextPageToken": string,
}
Fields
deviceRegistries[]

object(DeviceRegistry)

The registries that matched the query.

nextPageToken

string

If not empty, indicates that there may be more registries that match the request; this value should be passed in a new ListDeviceRegistriesRequest.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Auth Guide.

Send feedback about...

Google Cloud Internet of Things Core