Skip to content
OpenParablePublic APIs

Cloud IoT API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.

Cloud IoT API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 16 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://cloudiot.googleapis.com/
Version
v1
Endpoints
16
OpenAPI
Specification ↗
Spec updated
2023-04-13

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://cloudiot.googleapis.com/v1/NAME" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://cloudiot.googleapis.com/v1/NAME", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://cloudiot.googleapis.com/v1/NAME",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/v1/{name}Gets details about a device.
PATCH/v1/{name}Updates a device.
DELETE/v1/{name}Deletes a device.
GET/v1/{name}/configVersionsLists the last few versions of the device configuration in descending order (i.e.: newest first).
GET/v1/{name}/statesLists the last few versions of the device state in descending order (i.e.: newest first).
POST/v1/{name}:modifyCloudToDeviceConfigModifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers. Returns the modified configuration version and its metadata
POST/v1/{name}:sendCommandToDeviceSends 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 protoco
GET/v1/{parent}/devicesList devices in a device registry.
POST/v1/{parent}/devicesCreates a device in a device registry.
GET/v1/{parent}/registriesLists device registries.
POST/v1/{parent}/registriesCreates a device registry that contains devices.
POST/v1/{parent}:bindDeviceToGatewayAssociates the device with the gateway.
POST/v1/{parent}:unbindDeviceFromGatewayDeletes the association between the device and the gateway.
POST/v1/{resource}:getIamPolicyGets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
POST/v1/{resource}:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy.
POST/v1/{resource}:testIamPermissionsReturns 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 e

Questions

Does the Cloud IoT API API need an API key?

Yes. The Cloud IoT API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Cloud IoT API API support HTTPS?

Yes, the Cloud IoT API API is served over HTTPS.

How many endpoints does the Cloud IoT API API have?

Its OpenAPI description lists 16 endpoints in version v1. All of them are shown on this page.

What are alternatives to the Cloud IoT API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).