cloudiot

API

bookmark_border

Registers and manages IoT devices that connect to the Google Cloud Platform.

REST resource: v1.projects.locations.registries

Methods

Methods

bindDeviceToGateway

POST /v1/{parent=projects/*/locations/*/registries/*}:bindDeviceToGateway
Associates the device with the gateway

create

POST /v1/{parent=projects/*/locations/*}/registries
Creates a device registry

delete

DELETE /v1/{name=projects/*/locations/*/registries/*}
Deletes a device registry configuration

get

GET /v1/{name=projects/*/locations/*/registries/*}
Gets a device registry configuration

getIamPolicy

POST /v1/{resource=projects/*/locations/*/registries/*}:getIamPolicy
Gets the resource’s access control policy

list

GET /v1/{parent=projects/*/locations/*}/registries
Lists device registries

patch

PATCH /v1/{deviceRegistry.name=projects/*/locations/*/registries/*}
Updates a device registry configuration

setIamPolicy

POST /v1/{resource=projects/*/locations/*/registries/*}:setIamPolicy
Sets the access control policy on the specified resource

testIamPermissions

POST /v1/{resource=projects/*/locations/*/registries/*}:testIamPermissions
Returns permissions that a caller has on the specified resource

unbindDeviceFromGateway

POST /v1/{parent=projects/*/locations/*/registries/*}:unbindDeviceFromGateway
Deletes the association between the device and the gateway

REST resource: v1.projects.locations.registries.devices

Methods

Methods

create

POST /v1/{parent=projects/*/locations/*/registries/*}/devices
Creates a device in a device registry

delete

DELETE /v1/{name=projects/*/locations/*/registries/*/devices/*}
Deletes a device

get

GET /v1/{name=projects/*/locations/*/registries/*/devices/*}
Gets a device’s details

list

GET /v1/{parent=projects/*/locations/*/registries/*}/devices
List devices in a device registry

modifyCloudToDeviceConfig

POST /v1/{name=projects/*/locations/*/registries/*/devices/*}:modifyCloudToDeviceConfig
Modifies the device’s configuration, which is eventually sent from the ClearBlade IoT Core servers

patch

PATCH /v1/{device.name=projects/*/locations/*/registries/*/devices/*}
Updates a device

sendCommandToDevice

POST /v1/{name=projects/*/locations/*/registries/*/devices/*}:sendCommandToDevice
Sends a command to the specified device

REST resource: v1.projects.locations.registries.devices.configVersions

Methods

Methods

list

GET /v1/{name=projects/*/locations/*/registries/*/devices/*}/configVersions
Lists the device configuration’s last few versions in descending order (i.e., newest first)

REST resource: v1.projects.locations.registries.devices.states

Methods

Methods

list

GET /v1/{name=projects/*/locations/*/registries/*/devices/*}/states
Lists the device state’s last few versions in descending order (i.e., newest first)