Get current network settings

Returns Ethernet 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

  Describes whether the dhcp is on or off

• ip_address ipv4

  Ip address of the device

• mask ipv4

  MAske used by device

• gateway ipv4

  Gateway used by device

• dns ipv4

  DNS 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

  Describes the base error user might get

  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

  Describes the parameter that did not pass a validation

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

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

Loading...