Get current network settings

Returns network settings. If DHCP option is enabled, response will contain settings gained from DHCP server.

Responses

• 200
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• dhcp boolean

  enables/disables dhcp usage

• ip_address ipv4

  ip address of the device

• mask ipv4

  mask used for device's address

• gateway ipv4

  devices IP gateway

• dns ipv4

  address for the dns server that will be used by device

{
  "dhcp": false,
  "ip_address": "192.168.1.96",
  "mask": "255.255.255.0",
  "gateway": "192.168.1.1",
  "dns": "8.8.8.8"
}

{
  "dhcp": false,
  "ip_address": "192.168.1.96",
  "mask": "255.255.255.0",
  "gateway": "192.168.1.1",
  "dns": "8.8.8.8"
}

Please log in

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  object containing info about error

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

  extended info on error

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "invalid_authentication",
    "message": "Log In"
  }
}

Loading...