7. Lightware REST API Reference
UCX series – User's Manual
94
Applied firmware package: v1.2.0b9 | LDC software: v2.5.10b1
7.14.
Network Security
7.14.1.
Enable/Disable Ethernet Port
Request and Response
ɯ
header:
POST·http://
<ip>
/api/V1/MEDIA/ETHERNET/
<ethernet_port>
/Enabled·HTTP/1.1
ɯ
body:
<status>
ɮ
header:
200 OK
ɮ
body:
<status>
Parameters
Identifier
Parameter description
Parameter values
<ethernet_port>
Ethernet port number
P1-P5*
<status>
The port is enabled.
The port is disabled.
true
false
*The UCX-2x1-HC30 model has three Ethernet port (P1-P3).
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MEDIA/ETHERNET/P4/Enabled HTTP/1.1
ɯ
body: false
ɮ
header:
200 OK
ɮ
body: false
7.14.2. Query Network Service Port Number
Request and Response
#http #https
ɯ
header:
GET·http://
<ip>
/api/V1/MANAGEMENT/NETWORK/SERVICES/
<port>
/Port·HTTP/1.1
ɮ
header: 200·OK
ɮ
body:
<port_num>
Parameters
Identifier
Parameter description
Parameter values
<port>
Port type
HTTP
HTTPS
LW3
SERIAL1
SERIAL2
<port_num>
Port number
80
443
6107
8001
8002
Example
ɯ
header:
GET http://192.168.0.50/api/V1/MANAGEMENT/NETWORK/SERVICES/HTTP/Port HTTP/1.1
ɮ
header:
200 OK
ɮ
body: 80
7.14.3.
Enable/Disable Network Service Port
Request and Response
ɯ
header:
GET·http://
<ip>
/api/V1/MANAGEMENT/NETWORK/SERVICES/
<port>
/Enabled·HTTP/1.1
ɯ
body:
<status>
ɮ
header:
200 OK
ɮ
body:
<status>
Parameters
Identifier
Parameter description
Parameter values
<port>
Port type
HTTP
HTTPS
<status>
The port is enabled.
The port is disabled.
true
false
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MANAGEMENT/NETWORK/SERVICES/HTTP/Enabled HTTP/1.1
ɯ
body: false
ɮ
header:
200 OK
ɮ
body: false
7.14.4. Query the Username for Authentication
INFO:
UCX series deal with one user for authentication and the username (admin) can not be changed.
Request and Response
ɯ
header:
GET·http://
<ip>
/api/V1/MANAGEMENT/NETWORK/AUTH/USER1/Name·HTTP/1.1
ɮ
header: 200·OK
ɮ
body: admin
Example
ɯ
header:
GET http://192.168.0.50/api/V1/MANAGEMENT/NETWORK/AUTH/USER1/Name HTTP/1.1
ɮ
header:
200 OK
ɮ
body: admin