REST API Devices Routes Configuration Config Specific (Get)
April 13, 2023 at 2:39 AMRead the device-specific part of the configuration
Role
Read the subset of the configuration registers that are device-specific and freely readable (inventory number, IP address, etc).
NOTE
A few registers (such as the passwords) are device-specific but not freely readable.
Prototype
URL : /device/{$id}/config/specific
Method : GET
URL Params : {$id}
: the DeviceId of the device. Use GET /devices to enumerate the connected devices.
Request data : None
Success Response
Code : 200 OK
Content : a list of register with their address and value, as shown in the example below.
NOTE:
The freely-readable registers that could be read using this method are:
- Registers
0200
to0207
(inventory data, including the Configuration GUID), - Registers
0208
to020F
(license data), - Registers
0280
and0281
for network devices (IP settings).
Registers that are not explicitly defined (i.e. that keep their default value in the device) are not returned in the response.
Example
{
"0201": "494E56454E544F5259204E554D424552",
"0202": "44454D4F204445534B",
"0280": "C0A800E1FFFFFF00C0A80014C0A8000600000000"
}
Error Response
See Error Responses.