setState: projects.locations.registries.devices
- Aaron Allsbrook
- Jeff Slavin (Unlicensed)
- Akash Sharma
Sets the device’s state.
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
POST {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 the project, location, and registry info. prepended). |
|
The value must be |
Header parameters
Parameters | |
|---|---|
| See the note at the start of this document on where to find the token. |
Request body
The request body contains data with this structure:
JSON representation |
|---|
{
"state": {
object(DeviceState)
},
"gatewayInfo": {
object(GatewayInfo)
}
} |
Fields | |
|---|---|
|
The device state. |
|
Set if the message is sent through a gateway or a gateway is making the request on a device’s behalf. |
Response status codes
Code | Meaning |
|---|---|
204 | Success |
Response body
If successful, the response body will be empty.
DeviceState
The device state reported to ClearBlade IoT Core.
JSON representation |
|---|
{
"binaryData": string
} |
Fields | |
|---|---|
|
Data in binary format. A base64-encoded string. |