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 |
|
|---|---|
|
|
The device registry path or registryId. Required. For example, or
|
|
|
A device numeric ID list. If empty, this field is ignored. Maximum IDs: 10,000. |
|
|
|
|
|
The A comma-separated list of field names. |
|
|
Options related to gateways. |
|
|
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. |
|
|
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 |
|
|
The value returned by the last |
Header parameters
|
Parameters |
|
|---|---|
|
|
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.