Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Sets the device’s state.

Info

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 token required in the call can be found on the Registry Details page or a JWT generated ClearBlade-UserToken value can be set to a JWT (note the claims required for HTTP calls). Using


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 recommended preferred since it is device-specific.

...

The request body contains data with this structure:

JSON representation

Code Block
{
  "state": {
    object(DeviceState)
  },
  "gatewayInfo": {
    object(GatewayInfo)
  }
}

Fields

state

object(DeviceState)

The device state.

gatewayInfo

object(GatewayInfo)

Set if the message is sent through a gateway or a gateway is making the request on a device’s behalf.

...

The device state reported to ClearBlade IoT Core.

JSON representation

Code Block
{
  "binaryData": string
}

...