Skip to main content

Commands -- System & Misc

POST /api/cmd.config.apply

Apply the changes on pending config.

Available in 7.1.1 or later

Response

FieldTypeDescription
warningstringWarning message (only appears if there is one)

cURL Example

curl -b cookies.txt -H "Content-Type: application/json" \
-X POST http://192.168.1.1/api/cmd.config.apply
{
"stat": "ok"
}

POST /api/cmd.config.discard

Discard changes of pending config.

Available in 7.1.1 or later

cURL Example

curl -b cookies.txt -H "Content-Type: application/json" \
-X POST http://192.168.1.1/api/cmd.config.discard
{
"stat": "ok"
}

GET /api/cmd.ap

⚠️ Alpha API

Returns the status of the device Access Point.

Available in 7.0.2 or later

Response

FieldTypeDescription
supportbooleanIndicates AP support. Products without AP return false.
enablebooleanIndicates if AP is currently turned on
wanDependentboolean(Experimental) true when "Turn off AP when there is no Internet connectivity" is enabled

cURL Example

curl -b cookies.txt http://192.168.1.1/api/cmd.ap
{
"stat": "ok",
"response": {
"support": true,
"enable": true,
"wanDependent": true
}
}

POST /api/cmd.ap

⚠️ Alpha API

Switch on or shut down the device Access Point.

Available in 7.0.2 or later

Input Parameters

FieldTypeRequiredDescription
enablebooleantrue to switch on, false to turn off

Response

Same as GET /api/cmd.ap.

cURL Example

curl -b cookies.txt -H "Content-Type: application/json" \
-X POST -d '{"enable":true}' \
http://192.168.1.1/api/cmd.ap
{
"stat": "ok",
"response": {
"support": true,
"enable": true,
"wanDependent": true
}
}

POST /api/cmd.port.poe.disable

Disable the PoE of a port.

For Switch and Balance/MAX devices: Only Port ID is needed. The port must be enabled and configured as a LAN port (Balance/MAX).

For modular devices (e.g. EPX): If the device has more than one module, portId, moduleType, and moduleId are all required.

Returns fail when the device or port does not support PoE.

Available in 8.1.1 or later

Input Parameters

FieldTypeRequiredDescription
portnumber, object, or arraySingle port ID, Port object, or array of port IDs/Port objects

Port Object:

FieldTypeRequiredDescription
idnumberPort ID
moduleTypestringoptional*Module type (mandatory for modular devices)
moduleIdnumberoptional*Module ID (mandatory for modular devices)

cURL Example

curl -b cookies.txt -H "Content-Type: application/json" \
-X POST -d '{"port":[2,{"id":1,"moduleType":"E8","moduleId":2}]}' \
http://192.168.1.1/api/cmd.port.poe.disable
{
"stat": "ok"
}

POST /api/cmd.port.poe.enable

Enable the PoE of a port.

Same rules apply as cmd.port.poe.disable regarding device types and parameters.

Available in 8.1.1 or later

Input Parameters

Same as cmd.port.poe.disable.

cURL Example

curl -b cookies.txt -H "Content-Type: application/json" \
-X POST -d '{"port":[2,{"id":1,"moduleType":"E8","moduleId":2}]}' \
http://192.168.1.1/api/cmd.port.poe.enable
{
"stat": "ok"
}

POST /api/cmd.starlink

⚠️ Alpha API

Controls Starlink WAN to Reboot/Stow/Unstow the dish (Care Plan required).

Available in 8.5.0 or later

Input Parameters

FieldTypeRequiredDescription
connIdnumberWAN connection ID
actionstringreboot, stow, or unstow

cURL Example

curl -b cookies.txt -H "Content-Type: application/json" \
-X POST -d '{"connId":1,"action":"unstow"}' \
http://192.168.1.1/api/cmd.starlink
{
"stat": "ok"
}

POST /api/cmd.system.reboot

Reboot the device. Optionally specify which firmware to load after reboot by providing a firmware ID. To look up available firmware IDs, call /api/info.firmware.

Available in 8.2.0 or later

Input Parameters

FieldTypeRequiredDescription
firmwareIdnumberoptional1 or 2 -- firmware slot to boot from

cURL Example

curl -b cookies.txt -H "Content-Type: application/json" \
-X POST http://192.168.1.1/api/cmd.system.reboot
{
"stat": "ok"
}