Device

Description

This module enables the inspection of the device module as well as setting selected keys before the device transmitted it.

API

Endpoints

POST

Preset Device Information

GET

Preset Device Information

GET

Preset Device Information

Preset Device Information

This endpoint can be used to set some device information preemptively. Currently this is value for the ICCID.

POST

/api/v1/device

Access

This endpoint requires create permission for the resource device.

Request Body

Name	Description
deviceIdentifier string	The unique device identifier. Albeit being case insensitive, the upper case representation is used throughout the API. Pattern: ^(\S.)?(\\*|[a-zA-Z0-9=-]+)$
iccid string	The ICCID for the device Pattern: ^[0-9a-fA-F]
publicKey string	The public key that will be used to verify the challenge that the device returned. Pattern: ^[0-9a-fA-F]

Response

This endpoint simply returns Status 204 to indicate a successful operation and to save bandwidth.

Preset Device Information

This endpoint can be used to set some device information preemptively. Currently this is value for the ICCID.

GET

/api/v1/device

Access

This endpoint requires read permission for the resource device.

Query Parameter

Name	Description
depth integeroptional	Due to the fact that some resources follow certain hierarchies, the depth query parameter can be used to include nested information in the response. This can be used to minimize roundtrips and is generally advised for.

Response

Name	Description
deviceIdentifier string	The unique device identifier. Albeit being case insensitive, the upper case representation is used throughout the API. Pattern: ^(\S.)?(\\*|[a-zA-Z0-9=-]+)$
info objectoptional
info.informationSource stringenum	Possible values: DEVICE, USER
info.deviceIdentifier string	The unique device identifier. Albeit being case insensitive, the upper case representation is used throughout the API. Pattern: ^(\S.)?(\\*|[a-zA-Z0-9=-]+)$
info.publicKey stringoptional	The public key that will be used to verify the challenge that the device returned. Pattern: ^[0-9a-fA-F]
info.signAlgorithm stringoptional	The sign algorithm used
info.productIdentifier stringoptional	The product identifier name
info.hardwareIdentifierOne stringoptional	Hardware information
info.firmwareIdentifierOne stringoptional	Firmware information
info.hardwareIdentifierTwo stringoptional	Hardware information
info.firmwareIdentifierTwo stringoptional	Firmware information
info.hardwareIdentifierThree stringoptional	Hardware information
info.firmwareIdentifierThree stringoptional	Firmware information
info.autoUpdateEnabled booleanoptional	Whenever or not the auto update is enabled for the device
info.deviceIP integeroptional	Device IP Address
info.deviceGW integeroptional	Device Gateway Address
info.deviceNM integeroptional	Device NM Address
info.uptime integeroptional	The current uptime of the device
info.remainingMonthlyData integeroptional	The montly remaining data
info.iccid stringoptional	The ICCID for the device Pattern: ^[0-9a-fA-F]

Preset Device Information

This endpoint can be used to set some device information preemptively. Currently this is value for the ICCID.

GET

/api/v1/device/:deviceIdentifier

Access

This endpoint requires read permission for the resource device.

URL Parameter

Name	Description
deviceIdentifier string	The unique device identifier. Albeit being case insensitive, the upper case representation is used throughout the API. Pattern: ^(\S.)?(\\*|[a-zA-Z0-9=-]+)$

Response

Name	Description
informationSource stringenum	Possible values: DEVICE, USER
deviceIdentifier string	The unique device identifier. Albeit being case insensitive, the upper case representation is used throughout the API. Pattern: ^(\S.)?(\\*|[a-zA-Z0-9=-]+)$
publicKey stringoptional	The public key that will be used to verify the challenge that the device returned. Pattern: ^[0-9a-fA-F]
signAlgorithm stringoptional	The sign algorithm used
productIdentifier stringoptional	The product identifier name
hardwareIdentifierOne stringoptional	Hardware information
firmwareIdentifierOne stringoptional	Firmware information
hardwareIdentifierTwo stringoptional	Hardware information
firmwareIdentifierTwo stringoptional	Firmware information
hardwareIdentifierThree stringoptional	Hardware information
firmwareIdentifierThree stringoptional	Firmware information
autoUpdateEnabled booleanoptional	Whenever or not the auto update is enabled for the device
deviceIP integeroptional	Device IP Address
deviceGW integeroptional	Device Gateway Address
deviceNM integeroptional	Device NM Address
uptime integeroptional	The current uptime of the device
remainingMonthlyData integeroptional	The montly remaining data
iccid stringoptional	The ICCID for the device Pattern: ^[0-9a-fA-F]