7. Lightware REST API Reference
UCX series – User's Manual
93
Applied firmware package: v1.2.0b9 | LDC software: v2.5.10b1
7.13.3.
Change the Subnet Mask (Static)
Request and Response
#ipaddress
ɯ
header:
POST·http://
<ip>
/api/V1/MANAGEMENT/NETWORK/StaticNetworkMask·HTTP/1.1
ɯ
body:
<netmask>
ɮ
header:
200 OK
ɮ
body:
<netmask>
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MANAGEMENT/NETWORK/StaticNetworkMask
HTTP/1.1
ɯ
body: 255.255.255.0
ɮ
header:
200 OK
ɮ
body: 255.255.255.0
ɯ
header:
POST http://192.168.0.50/api/V1/MANAGEMENT/NETWORK/applySettings HTTP/1.1
ɮ
header:
200 OK
ɮ
body: OK
INFO:
The
applySettings
method will save and apply the new value and results the device to reboot.
INFO:
The current setting can be queried by using the
7.13.4.
Change the Gateway Address (Static)
Request and Response
ɯ
header:
POST·http://
<ip>
/api/V1/MANAGEMENT/NETWORK/StaticGatewayAddress·HTTP/1.1
ɯ
body:
<gw_address>
ɮ
header:
200 OK
ɮ
body:
<gw_address>
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MANAGEMENT/NETWORK/StaticGatewayAddress HTTP/1.1
ɯ
body: 192.168.0.1
ɮ
header:
200 OK
ɮ
body: 192.168.0.1
ɯ
header:
POST http://192.168.0.50/api/V1/MANAGEMENT/NETWORK/applySettings HTTP/1.1
ɮ
header:
200 OK
ɮ
body: OK
INFO:
The
applySettings
method will save and apply the new value and results the extender to reboot.
INFO:
The current setting can be queried by using the
7.13.5.
Apply Network Settings
Request and Response
ɯ
header:
POST·http://
<ip>
/api/V1/MANAGEMENT/NETWORK/applySettings·HTTP/1.1
INFO:
The body has to be empty, and the content type should be text/plain.
ɮ
header:
200 OK
ɮ
body: OK
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MANAGEMENT/NETWORK/applySettings HTTP/1.1
ɮ
header:
200 OK
ɮ
body: OK
All network settings which are changed have been applied and network interface restarts.
7.13.6.
Setting the Hostname
The host name is a property that can be used instead of the IP address when connecting to the device. It is
also suitable for finding in the Device Discovery window of the LDC, see more details in the
section. Furthermore, it can be used to open the The Built-in Miniweb. If the IP address of the device
is changing, the host name can be used as a fixed property.
After hostname changing restart network services is required. New SSL certificate will be generated.
Request and Response
ɯ
header:
POST·http://
<ip>
/api/V1/MANAGEMENT/NETWORK/HostName·HTTP/1.1
ɯ
body:
<unique_name>
ɮ
header:
200 OK
ɮ
body:
<unique_name>
Parameters
The
<unique_name>
can be 1-64 character long and the following are allowed for naming: the elements of
the English alphabet and numbers. Hyphen (-) and dot (.) is also accepted except as last character.
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MANAGEMENT/NETWORK/HostName HTTP/1.1
ɯ
body: room-switcher
ɮ
header:
200 OK
ɮ
body: room-switcher