7. Lightware REST API Reference
6.5. System Commands
6.5.1. Setting the Device Label
INFO:
The device label can be changed to a custom text in the
Request and Response
#devicelabel
request-line: POST·http://<ip>/api/V1/MANAGEMENT/LABEL/DeviceLabel·HTTP/1.1
ɯ
body:
<custom_name>
ɯ
ɮ
status-line: 200·OK
ɮ
body:
<custom_name>
The Device Label can be 49 character long and ASCII characters are allowed. Longer names are truncated.
Example
request-line: POST http://192.168.0.50/api/V1/MANAGEMENT/LABEL/DeviceLabel HTTP/1.1
ɯ
body:
MMX2room
ɯ
ɮ
status-line: 200 OK
ɮ
body:
MMX2room
6.5.2. Resetting the Device
The switcher can be restarted – the current connections will be terminated.
Request and Response
#reboot #restart
request-line: POST·http://<ip>/api/V1/SYS/restart·HTTP/1.1
ɯ
The body has to be empty, and the content type should be text/plain.
INFO:
ɮ
staus-line:
200 OK
Example
request-line: POST http://192.168.0.50/api/V1/SYS/restart HTTP/1.1
ɯ
ɮ
status-line: 200 OK
6.5.3. Restoring the Factory Default Settings
Request and Response
request-line: POST·http://<ip>/api/V1/SYS/factoryDefaults·HTTP/1.1
ɯ
The body has to be empty, and the content type should be text/plain.
INFO:
ɮ
status-line: 200 OK
Example
request-line: POST http://192.168.0.50/api/V1/SYS/factoryDefaults HTTP/1.1
ɯ
ɮ
status-line: 200 OK
The device is restarted, current connections are terminated, and the default settings are restored. See the
complete list in the
Factory Default Settings
tab of the LDC software.
Status
#label
section.
#factory
Applied firmware package: v2.9.0b6 | LDC software: v2.7.6b4
MMX2 series – User's Manual
6.5.4. Querying the Firmware Package Version
Response #firmwareversion
Request and
request-line: GET·http://<ip>/api/V1/MANAGEMENT/UID/PACKAGE/Version·HTTP/1.1
ɯ
ɮ
status-line: 200·OK
<firmware_version>
ɮ
body:
Example
request-line: GET http://192.168.0.50/api/V1/MANAGEMENT/UID/PACKAGE/Version HTTP/1.1
ɯ
ɮ
status-line: 200 OK
ɮ
body:
1.3.3b3
6.5.5. Control Lock
Enable/disable the operation of the front panel buttons.
Request and Response
#lockbutton
request-line: POST·http://<ip>/api/V1/MANAGEMENT/UI/ControlLock·HTTP/1.1
ɯ
ɯ
body:
<lock_status>
ɮ
status-line: 200·OK
ɮ
body:
<lock_status>
Parameters
Parameter
Parameter description Values
<lock_status>
Front panel button
locking status
Example
request-line: POST http://192.168.0.50/api/V1/MANAGEMENT/UI/ControlLock HTTP/1.1
ɯ
ɯ
body:
force locked
status-line: 200 OK
ɮ
body:
Force locked
ɮ
#buttonlock
Value description
None
None: all functions of the front panel button are enabled.
locked
The front panel buttons are locked, and can be unlocked
Lock).
by a button combination
(Control
force
The front panel buttons are locked and cannot be
unlocked by a button combination, only in LDC (on the
locked
tab) or using the LW3 command (or REST API).
Status
62
Need help?
Do you have a question about the MMX2-4x3-H20 and is the answer not in the manual?