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 on 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.

...

POST {URL}/api/v/4/webhook/execute/{SystemKey}/cloudiotdevice_devices

Query 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).

method

string 

The value must be setState

Header parameters

Parameters

ClearBlade-UserToken

See the note at the start of this document on where to find the token.

Request body

The request body contains data with the following 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

of a device

.

Response status codes

Code

Meaning

204

Success

Response body

If successful, the response body will be empty.

...

The device state reported to ClearBlade IoT Core.

JSON representation

Code Block
{
  "binaryData": string
}

Fields

binaryData

string (bytes format)

Data in binary format.

A base64-encoded string.