Documentation

Mistake on this page? Email us

DeviceUpdateRequest

Hierarchy

  • DeviceUpdateRequest

Index

Properties

autoUpdate

autoUpdate: boolean

DEPRECATED: Mark this device for automatic firmware update.

caId

caId: string

The certificate issuer's ID.

example

00000000000000000000000000000000

customAttributes

customAttributes: object

Up to five custom key-value attributes. Note that keys cannot begin with a number. Both keys and values are limited to 128 characters. Updating this field replaces existing contents.

example

[object Object]

Type declaration

  • [key: string]: string

description

description: string

The description of the device.

example

Temperature measuring device

deviceKey

deviceKey: string

The fingerprint of the device certificate.

example

00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00

endpointName

endpointName: string

The endpoint name given to the device. The endpoint_name is from the device certificate and is set by factory tool.

example

00000000-0000-0000-0000-000000000000

endpointType

endpointType: string

The endpoint type of the device. For example, the device is a gateway.

hostGateway

hostGateway: string

The ID of the host gateway, if appropriate. A device behind Edge has this host_gateway set.

name

name: string

The name given by the web application for the device. Device itself provides only the endpoint_name.

example

00000000-0000-0000-0000-000000000000