Skip to main content
Skip table of contents

list: projects.locations.registries.devices

Lists a device registry’s devices.

Note: This is a regional API.

You can find the URL, SystemKey, and token required in the call by clicking API Keys (key icon) at the top-right of the Registry Details page. Use the Registry Keys section.

HTTP request

GET {URL}/api/v/4/webhook/execute/{SystemKey}/cloudiot_devices

Query parameters

Parameters

parent

string

The device registry path or registryId. Required.

For example, projects/my-project/locations/us-central1/registries/my-registry.

or

my-registry

deviceNumIds

string

A device numeric ID list. If empty, this field is ignored. Maximum IDs: 10,000.

deviceIds

string

fieldMask

string (FieldMask format)

The Device resource’s fields to be returned in the response. The fields id and numId are always returned, along with any other fields specified.

A comma-separated list of field names.

gatewayListOptions

object(GatewayListOptions)

Options related to gateways.

pageSize

number

The maximum number of devices 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. A non-empty nextPageToken in the response indicates that more data is available.

pageToken

string

The value returned by the last ListDevicesResponse; indicates that this is a prior devices.list call’s continuation and the system should return the next page of data.

Header parameters

Parameters

ClearBlade-UserToken

See the note at the start of this document on where to find the token.

Request body

The request body must be empty.

Response status codes

Code

Meaning

200

Success

Response body

If successful, the response body contains a ListDevicesResponse instance.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.