get: projects.locations.registries.devices

Gets a device’s details.

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

Parameters

name

string

The device’s name. For example, projects/p0/locations/us-central1/registries/registry0/devices/device0

or

projects/p0/locations/us-central1/registries/registry0/devices/{numId}.

The device’s name can be set to the deviceId or numId (i.e., without the project, location, and registry info. prepended).

fieldMask

string (FieldMask format)

The Device resource’s fields to be returned in the response. If the field mask is unset or empty, all fields are returned.

A comma-separated list of field names.

base64Encode

string

Optional parameter that designates whether state binaryData is to be returned as base64-encoded strings. If the parameter is present, its value must be true or false (case is ignored). If the parameter is missing, the result is the same as if it was present and its value was false. I.e., state binaryData is returned, NOT base64-encoded.

Header parameters

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

Code	Meaning
200	Success

Response body

If successful, the response body contains a device instance.