Cloud IoT API
Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.
IoT & devices#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.
Endpoints 16
projects
- GETcloudiot.projects.locations.registries.devices.get
/v1/:name?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=string&fieldMask=stringGets details about a device. - DELETEcloudiot.projects.locations.registries.devices.delete
/v1/:name?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringDeletes a device. - PATCHcloudiot.projects.locations.registries.devices.patch
/v1/:name?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=string&updateMask=stringUpdates a device. - GETcloudiot.projects.locations.registries.devices.configVersions.list
/v1/:name/configVersions?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=string&numVersions=0Lists the last few versions of the device configuration in descending order (i.e.: newest first). - GETcloudiot.projects.locations.registries.devices.states.list
/v1/:name/states?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=string&numStates=0Lists the last few versions of the device state in descending order (i.e.: newest first). - POSTcloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig
/v1/:name:modifyCloudToDeviceConfig?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringModifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers. Returns the modified configuration version and its… - POSTcloudiot.projects.locations.registries.devices.sendCommandToDevice
/v1/:name:sendCommandToDevice?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringSends a command to the specified device. In order for a device to be able to receive commands, it must: 1) be connected to Cloud IoT Core using the MQTT… - GETcloudiot.projects.locations.registries.groups.devices.list
/v1/:parent/devices?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=string&deviceIds=string&deviceNumIds=string&fieldMask=string&gatewayListOptions.associationsDeviceId=string&gatewayListOptions.associationsGatewayId=string&gatewayListOptions.gatewayType=GATEWAY_TYPE_UNSPECIFIED&pageSize=0&pageToken=stringList devices in a device registry. - POSTcloudiot.projects.locations.registries.devices.create
/v1/:parent/devices?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringCreates a device in a device registry. - GETcloudiot.projects.locations.registries.list
/v1/:parent/registries?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=string&pageSize=0&pageToken=stringLists device registries. - POSTcloudiot.projects.locations.registries.create
/v1/:parent/registries?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringCreates a device registry that contains devices. - POSTcloudiot.projects.locations.registries.bindDeviceToGateway
/v1/:parent:bindDeviceToGateway?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringAssociates the device with the gateway. - POSTcloudiot.projects.locations.registries.unbindDeviceFromGateway
/v1/:parent:unbindDeviceFromGateway?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringDeletes the association between the device and the gateway. - POSTcloudiot.projects.locations.registries.groups.getIamPolicy
/v1/:resource:getIamPolicy?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringGets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - POSTcloudiot.projects.locations.registries.groups.setIamPolicy
/v1/:resource:setIamPolicy?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringSets the access control policy on the specified resource. Replaces any existing policy. - POSTcloudiot.projects.locations.registries.groups.testIamPermissions
/v1/:resource:testIamPermissions?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND…
API details
- Base URL
https://cloudiot.googleapis.com- Authentication
- OAuth 2.0 (implicit flow) with 2 scopes
OAuth 2.0 (authorization code flow) with 2 scopes - Operations
- 16 operations on 12 pathsPOST 9GET 5PATCH 1DELETE 1
- Main resources
- projects 16
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
v1 - Links
- Documentation · OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Cloud IoT API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud IoT API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “cloudiot.projects.locations.registries.devices.get” (GET /v1/:name?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=string&fieldMask=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Cloud IoT API?
Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform. It is listed under IoT & devices and has 16 endpoints.
Who publishes the Cloud IoT API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Cloud IoT API?
Requests go to https://cloudiot.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Cloud IoT API?
It accepts 2 methods: OAuth 2.0 (implicit flow) with 2 scopes; OAuth 2.0 (authorization code flow) with 2 scopes.
How many endpoints does the Cloud IoT API have?
16 operations on 12 paths (9 POST, 5 GET, 1 PATCH, 1 DELETE). The largest groups are projects.
Is forking the Cloud IoT API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.