REST reference
Â
The ClearBlade IoT Core API has cloudiot
, cloudiotdevice
, and policy
REST resources.
policy
policy
methods facilitate managing roles and permissions.
queryGrantableRoles: List all grantable roles on a specified resource.
getIamPolicy: Get a specified resource’s IAM policy.
setIamPolicy: Set a specified resource’s IAM policy.
testIamPermissions: Test whether a user has a list of permissions for a specified resource.
cloudiot
cloudiot
methods facilitate device manager tasks: creating and managing registries and devices, updating device configuration, and getting device state.
projects.locations.registries: Create, get, list, patch, and delete registries, and manage policies and permissions.
projects.locations.registries.devices: Create, get, list, patch, and delete devices, and modify device configurations.
projects.locations.registries.devices.configVersions: List device configurations.
projects.locations.registries.devices.states: List device states.
cloudiotdevice
cloudiotdevice
methods facilitate device communication over the HTTP bridge. Use these methods to get device configuration, publish device telemetry, and set device state.
projects.locations.registries.devices.getConfig: Get the device’s configuration from ClearBlade IoT Core (see the
localVersion
parameter description for details about which configuration is returned).projects.locations.registries.devices.publishEvent: Publish a device telemetry event.
projects.locations.registries.devices.setState: Report the device’s state to ClearBlade IoT Core.
API documentation
The API reference documentation is organized by resource. Review the documentation for all resources when building clients and trying out commands.
API version
The ClearBlade IoT Core API’s current version is v1.
Version cloudiotdevice
v1beta1 is deprecated.
MQTT broker
ClearBlade IoT Core also runs a managed broker that listens to mqtt.googleapis.com:8883
and mqtt.googleapis.com:443
. This endpoint does not offer a REST API but supports standard MQTT operations. For more information, see the MQTT server and specification.