getConfig: project.locations.registries.devices
Gets the device’s configuration.
Note: This is a regional API.
You can find the URL and SystemKey required in the call by clicking API Keys (key icon) at the top-right of the Registry Details page.
The ClearBlade-UserToken value can be set to a JWT (note the claims required for HTTP calls).
NOTE: Applicable only for https://iot.clearblade.com users:
The ClearBlade-UserToken value can also be set to the token found by clicking the API keys icon at the top-right of the Registry Details page. However, using the JWT is preferred since it is device-specific.
HTTP request
GET {URL}/api/v/4/webhook/execute/{SystemKey}/cloudiotdevice_devices
Query parameters
Parameters | |
|---|---|
|
The device’s name. For example, or
The device’s name can be set to the deviceId or numId (i.e., without project, location, and registry info. prepended). |
|
If zero, returns the current device configuration from ClearBlade IoT Core. If nonzero, specifies the device configuration’s local version. The server returns config data only if a newer version from ClearBlade IoT Core is available. If this value exceeds the latest version available in ClearBlade IoT Core, returns an |
|
Set if the message is sent through a gateway or a gateway is making the request on a device’s behalf. |
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 data with this structure:
JSON representation |
|---|
{
"version": string,
"binaryData": string
} |
Fields | |
|---|---|
|
ClearBlade IoT Core’s configuration version. |
|
Data in binary format. A base64-encoded string. |