• Network
  • Read the configuration
    • path: /network
    • method: GET
  • Edit the configuration
    • path: /network
    • method: PUT
  • data
    • format: json object
    • fields:
      • state: enum: "disconnected|connecting|connected", default: "disconnected" (read_only)
      • dhcp_enabled: boolean, default: true (read/write)
      • ip: string in IPv4 format or null (read/write), constraint: ipv4_constraint
      • netmask: string in "netmask" format or null (read/write), constraint: netmask_constraint
      • gateway: string in IPv4 format or null (read/write), constraint: ipv4_constraint
      • nameserver: string in IPv4 format or null (read/write), constraint: ipv4_constraint
      • mac: string in MAC format or null (read only), constraint: mac_constraint
      • hostname: string in hostname format or null (read/write), constraint: hostname_constraint, default: iota_[mac in lowercase, without separators]
      • block_internal_access: boolean, default: false (read/write)
      • block_external_access: boolean, default: false (read/write)
      • authentication: [authentication object] (read/write)
    • authentication object
      • format: json object
        • description: 802.1x authentication
        • fields
          • enabled: bool, default: false (read/write)
          • parameters: json object, default: null (read/write)
            • eap: "md5" or "tls", must be set, default: "md5"
            • key_mgmt: "ieee8021x", read-only
            • additional parameters depending on eap and key_mgmt:
              • md5 and ieee8021x
                • fields
                  • identity: string (min 1 character, max 1024)
                  • password: string (min 0 character, max 4096), returned as "hidden" in GET

                • example

                  {
                      "enabled": true,
                      "parameters":
                      {
                          "eap": "md5",
                          "key_mgmt": "ieee8021x",
                          "identity": "john",
                          "password": "hidden"
                      }
                  }

              • tls and ieee8021x
                • fields
                  • identity: string (min 1 character, max 1024), read/write
                  • ca_cert: string (min 1 character, max 4096) in PEM format (as string, linebreaks must be escaped as ) or null, read/write, returned as null (if not present) or as "hidden" in GET
                  • client_cert: string (min 1 character, max 4096) in PEM/DER format (as string, linebreaks must be escaped as ), read/write, returned as "hidden" in GET
                  • private_key: string (min 1 character, max 4096) in PEM/DER/PFX format (as string, linebreaks must be escaped as ), read/write, returned as "hidden" in GET
                  • private_key_pw: string (min 0 character, max 4096) or null, read/write, returned as null (if not present) or as "hidden" in GET

                • example

                  {
                      "enabled": true,
                      "parameters":
                      {
                          "eap": "tls",
                          "key_mgmt": "ieee8021x",
                          "identity": "john",
                          "ca_cert": null,
                          "client_cert": "hidden",
                          "private_key": "hidden",
                          "private_key_pw": "hidden"
                      }
                  }

    • behavior:
      • setting dhcp_enabled is true:
        • it changes the following fields with the new configuration from DHCP:
          • ip
          • netmask
          • gateway
          • nameserver
        • if it could not connect in 30 seconds, it enables a static IP on fallback_static_ip with fallback_netmask
          • note: it is automatically disabled if they change the config
      • setting dhcp_enabled is false:
        • the following fields must be sent:
          • ip (contraint: ip_must_be_present_in_static_configuration)
          • netmask (constraint: netmask_must_be_present_in_static_configuration)
        • if nameserver is not present, it will set it to the gateway address

Back to Index