Devices data models

Represents a device instance created by a project.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
apiKey	string	No	read-only (server-generated)	API access key assigned to device. Usually hidden except to privileged clients, but is also present during the On-Demand Device Provisioning process.
bundleInstallTime	string	No	read-only (server-generated); format: date-time	If present, the timestamp when the firmware bundle was installed.
bundleInstalled	string	No	read-only (server-generated)	If present, the name of firmware bundle installed on this device.
channel	string	No	read-only (server-generated)	The name of firmware channel the device should download from.
claimCode	string	No		Claim code assigned to device. Hidden except to privileged clients.
claimExpirationTime	string	No	read-only (server-generated); format: date-time	Expiration time of device's claimable state.
claimTime	string	No	read-only (server-generated); format: date-time	Timestamp of device being claimed by a user.
creationTime	string	No	read-only (server-generated); format: date-time	Timestamp of device record creation.
description	string	No		Description of device.
deviceClass	string	Yes	read-only (server-generated)	Device Class ID as defined by the project.
homeId	integer	No		This property is present if device belongs to a home.
id	integer	Yes	read-only (server-generated)	Unique device ID.
isConnected	boolean	No	read-only (server-generated)	Device is currently connected to MODE Cloud via a websocket or MQTT connection.
lastConnectTime	string	No	read-only (server-generated); format: date-time	The last time the device connected to the cloud.
lastDisconnectTime	string	No	read-only (server-generated); format: date-time	The last time the device disconnected from the cloud.
name	string	No		Display name of device.
projectId	integer	Yes	read-only (server-generated)	Project that this device belongs to.
tag	string	No		An optional/informational tag associated with device. Can be used to store the serial number, for example.

Represents the configuration schema associated with a device component.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
componentName	string	No	read-only (server-generated)	Display name of component and is unique per project.
componentVersionName	string	No	read-only (server-generated)	Display name of component version e.g. 1.0.1
deviceConfigSchema	array	No	read-only (server-generated)	A template used to create a configuration for a firmware component.

Entry in an HTTP access log.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
clientIp	string	No	read-only (server-generated)	IP address of caller.
latency	integer	No	read-only (server-generated)	Elapsed time of call in nanoseconds.
method	string	No	read-only (server-generated)	HTTP method.
path	string	No	read-only (server-generated)	URI path of HTTP request.
statusCode	integer	No	read-only (server-generated)	Returned status code of HTTP request.
timestamp	string	No	read-only (server-generated); format: date-time	Timestamp of entry creation.

A key-value pair stored for a home.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
key	string	No	read-only (server-generated); pattern: ^[a-zA-Z0-9]([a-zA-Z0-9\-_\:]*[a-zA-Z0-9])*$	Must be unique within each home. Must 1 to 256 characters and must contain alphanumeric characters; dashes ('-'), underscores ('_') and colons (':') may be used after the first character but must be followed by 1+ alphanumeric characters.
modificationTime	string	No	read-only (server-generated); format: date-time	Timestamp of creation or last modification.
value	boolean | string | number | array | object	Yes		An arbitrary piece of data assigned to the given key.

Entry in a general-purpose log.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
caller	object	No		Information about the caller (id, type, display name, sudoer).
level	integer	No	read-only (server-generated)	Log level of entry.
source	string	No		Source from where the message was generated.
text	string	No	read-only (server-generated)	Text of log message.
timestamp	string	No	read-only (server-generated); format: date-time	Timestamp of entry creation.

Represents a request to a device for uploading its logs.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
contentType	string	No		MIME type of file uploaded for this request.
deviceId	integer	No		ID of device associated with log request.
filename	string	No		Filename of uploaded device log.
id	string	No		Unique ID of log request
projectId	integer	No		ID of project associated with log request.
status	unknown	No	one of: success, failure, requested, uploading, cancelled	Status of log request.
token	string	No		Request token sent to device.
ts	string	No	format: date-time	Creation timestamp of log request.
uploadId	string	No		Unique ID assigned to an upload session.
url	string	No		URL for downloading the stored device log.