This endpoint is used to get the network settings of the specified device.
Response Payload Object
Property | Type | Description |
|---|---|---|
defaultGateway | string | The default gateway that the device will use to connect to the network. (Only used when the IP mode is set to false) |
ipAddress | string | The IP address the device has on the current network. |
ipMode | integer | Whether or not the device should automatically handle its network connection settings. The values will either be 0 for static or 1 for DHCP. |
netmask | string | The netmask that the device will use to connect to the network. (Only used when the IP mode is set to false) |
dnsServer | string | The DNS server that the device will use to connect to the network. (Only used when the IP mode is set to false) |
Controlled Errors
Error Code | Error Message |
|---|---|
error_device_network_setting_not_found | No device settings were found. |
Any status codes returned that are not provided here are generic status codes that can be found here.