2.35 configuration/system/network

GET

Get the network settings.

Responses
200GET successful.
Response (application/json): object
MemberTypeDescription
hostname
string

The hostname of the Base Unit. Hostnames are human-readable nicknames that correspond to the address of a device connected to a network.

Example: ClickShare-1234567890

services
object 
  dhcpServer
object 
    domainName
string

Indicates the domain name given to the DHCP leases.

Example: clickshare

read-only

    leases
array

The DHCP leases.

read-only

    leaseTime
integer

Number of seconds the leases are valid.

read-only

    maxAddress
string (ipv4)

Highest IP address of the range used by the DHCP server.

Example: 192.168.2.254

read-only

    minAddress
string (ipv4)

Lowest IP address of the range used by the DHCP server.

Example: 192.168.2.2

read-only

    subnetMask
string (ipv4)

The subnet mask for IP leases.

Example: 255.255.255.0

  proxy
object 
    enabled
booleanIndicates if the proxy server is enabled or disabled.
    password
string (password)

The password for the proxy server.

write-only

    serverAddress
string (ipv4)

IP address of the proxy server.

Example: 10.11.0.15

    serverPort
integer

Port number of the proxy number.

Example: 80

    username
stringThe username for the proxy server.
wired
arrayread-only
wireless
arrayread-only
PATCH

Change the network settings.

Request body (application/json): object
MemberTypeDescription
hostname
string

The hostname of the Base Unit. Hostnames are human-readable nicknames that correspond to the address of a device connected to a network.

Example: ClickShare-1234567890

services
object 
  dhcpServer
object 
    domainName
string

Indicates the domain name given to the DHCP leases.

Example: clickshare

read-only

    leases
array

The DHCP leases.

read-only

    leaseTime
integer

Number of seconds the leases are valid.

read-only

    maxAddress
string (ipv4)

Highest IP address of the range used by the DHCP server.

Example: 192.168.2.254

read-only

    minAddress
string (ipv4)

Lowest IP address of the range used by the DHCP server.

Example: 192.168.2.2

read-only

    subnetMask
string (ipv4)

The subnet mask for IP leases.

Example: 255.255.255.0

  proxy
object 
    enabled
booleanIndicates if the proxy server is enabled or disabled.
    password
string (password)

The password for the proxy server.

write-only

    serverAddress
string (ipv4)

IP address of the proxy server.

Example: 10.11.0.15

    serverPort
integer

Port number of the proxy number.

Example: 80

    username
stringThe username for the proxy server.
wired
arrayread-only
wireless
arrayread-only
Responses
200PATCH successful.