Device

JSON Representation
Methods

A set of methods for managing devices.

JSON Representation

{
  "id": "string",
  "registryId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "topicAliases": "object",
  "status": "string",
  "monitoringData": {
    "lastAuthIp": "string",
    "lastAuthTime": "string",
    "lastPubActivityTime": "string",
    "lastSubActivityTime": "string",
    "lastOnlineTime": "string"
  }
}

Field	Description
id	string ID of the device.
registryId	string ID of the registry that the device belongs to.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format.
name	string Name of the device. The name is unique within the registry.
description	string Description of the device. 0-256 characters long.
topicAliases	object Alias of a device topic. Alias is an alternate name of a device topic assigned by the user. Map alias to canonical topic name prefix, e.g. `my/custom/alias` match to `$device/abcdef/events`.
status	string Status of the device. CREATING: Device is being created. ACTIVE: Device is ready to use. DELETING: Device is being deleted.
monitoringData	object Device monitoring data, returns if FULL view specified.
monitoringData. lastAuthIp	string
monitoringData. lastAuthTime	string (date-time) String in RFC3339 text format.
monitoringData. lastPubActivityTime	string (date-time) String in RFC3339 text format.
monitoringData. lastSubActivityTime	string (date-time) String in RFC3339 text format.
monitoringData. lastOnlineTime	string (date-time) String in RFC3339 text format.

Methods

Method	Description
addCertificate	Adds a certificate.
addPassword	Adds password for the specified device.
create	Creates a device in the specified registry.
delete	Deletes the specified device.
deleteCertificate	Deletes the specified device certificate.
deletePassword	Deletes the specified password.
get	Returns the specified device.
list	Retrieves the list of devices in the specified registry.
listCertificates	Retrieves the list of device certificates for the specified device.
listOperations	Lists operations for the specified device.
listPasswords	Retrieves the list of passwords for the specified device.
update	Updates the specified device.