Documentation

Mistake on this page? Email us

DeviceCreateRequest

Hierarchy

  • DeviceCreateRequest

Index

Properties

autoUpdate

autoUpdate: boolean

DEPRECATED: Mark this device for automatic firmware update.

bootstrapExpirationDate

bootstrapExpirationDate: Date

The expiration date of the certificate used to connect to bootstrap server.

caId

caId: string

The certificate issuer's ID.

example

00000000000000000000000000000000

connectorExpirationDate

connectorExpirationDate: Date

The expiration date of the certificate used to connect to LwM2M server.

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

deployment

deployment: string

DEPRECATED: The last deployment used on the device.

description

description: string

The description of the device.

example

description

deviceClass

deviceClass: string

An ID representing the model and hardware revision of the device.

deviceExecutionMode

deviceExecutionMode: number

The execution mode from the certificate of the device. Defaults to inheriting from host_gateway device. Permitted values:

  • 0 - unspecified execution mode (default if host_gateway invalid or not set)
  • 1 - development devices
  • 5 - production devices

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.

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.

issuerFingerprint

issuerFingerprint: string

SHA256 fingerprint of the certificate used to validate the signature of the device certificate.

example

C42EDEFC75871E4CE2146FCDA67D03DDA05CC26FDF93B17B55F42C1EADFDC322

manifest

manifest: string

DEPRECATED: The URL for the current device manifest.

mechanism

mechanism: DeviceMechanism

The ID of the channel used to communicate with the device.

mechanismUrl

mechanismUrl: string

The address of the connector to use.

name

name: string

The name of the device.

example

00000000-0000-0000-0000-000000000000

serialNumber

serialNumber: string

The serial number of the device.

example

00000000-0000-0000-0000-000000000000

state

The current state of the device.

vendorId

vendorId: string

The device vendor ID.

example

00000000-0000-0000-0000-000000000000