ClearBlade IoT Core
ClearBlade IoT Core
Breadcrumbs

getConfig: project.locations.registries.devices

Gets the device’s configuration.

Note: This is a regional API.

You can find the URL and SystemKey required in the call by clicking API Keys (key icon) at the top-right of the Registry Details page.

A ClearBlade-UserToken header is required to call this API. Its value is set as follows:

  • If using IoT Core Standard the value can be either…

    • The Token found under API Keys OR

    • A JWT generated as specified here and signed by the private key of the device specified in the name Query parameter (see below). A JWT for any other user or device will be rejected.

  • If using IoT Core Enterprise the value MUST be a JWT generated as specified here and signed by the private key of the device specified in the name Query parameter (see below). A JWT for any other user or device will be rejected.

HTTP request

GET {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 project, location, and registry info. prepended).

localVersion

string (int64 format)

If zero, returns the current device configuration from ClearBlade IoT Core. If nonzero, specifies the device configuration’s local version. The server returns config data only if a newer version from ClearBlade IoT Core is available. If this value exceeds the latest version available in ClearBlade IoT Core, returns an OUT_OF_RANGE error.

gatewayInfo

object(GatewayInfo)

Set if the message is sent through a gateway or a gateway is making the request on a device’s behalf.

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 must be empty.

Response status codes

Code

Meaning

200

Success

Response body

If successful, the response body contains data with this structure:

JSON representation

 
{
  "version": string,
  "binaryData": string
}

Fields

version

string (int64 format)

ClearBlade IoT Core’s configuration version.

binaryData

string (bytes format)

Data in binary format.

A base64-encoded string.