OpenWrt JSON-RPC

README.md

OpenWrt JSON-RPC

Dependencies

• curl
• jq (optional)
• sh

Authentication

# Update OPENWRT_HOSTNAME and OPENWRT_USERNAME in environment.sh before proceeding
sh ./environment.sh
export OPENWRT_PASSWORD="{{password}}" # set the password here
export OPENWRT_TOKEN="$(sh ./auth.sh | jq .result)"

Examples

# Be sure to set the OPENWRT_TOKEN before making any requests
sh ./sys_net_conntrack.sh
sh ./sys_net_devices.sh
sh ./sys_uptime.sh
sh ./uci_get_all_network.sh

License

SPDX: GPL-3.0-or-later

See Also

• HowTo: Using the JSON-RPC API

auth.sh

#!/bin/sh
set -e

. ./request.sh

URL="https://${OPENWRT_HOSTNAME}/cgi-bin/luci/rpc/auth"

request "{ \"id\": 1, \"method\": \"login\", \"params\": [ \"${OPENWRT_USERNAME}\", \"${OPENWRT_PASSWORD}\" ] }"

environment.sh

#!/bin/sh
set -e

export OPENWRT_HOSTNAME=""
export OPENWRT_USERNAME=""
unset OPENWRT_PASSWORD
unset OPENWRT_TOKEN

request.sh

#!/bin/sh
set -e

request() {
  curl "${URL}" --data "${1}"
}

sys_net_conntrack.sh

#!/bin/sh
set -e

. ./request.sh

URL="https://${OPENWRT_HOSTNAME}/cgi-bin/luci/rpc/sys?auth=${OPENWRT_TOKEN}"

request "{ \"method\": \"net.conntrack\" }"

sys_net_devices.sh

#!/bin/sh
set -e

. ./request.sh

URL="https://${OPENWRT_HOSTNAME}/cgi-bin/luci/rpc/sys?auth=${OPENWRT_TOKEN}"

request "{ \"method\": \"net.devices\" }"

sys_uptime.sh

#!/bin/sh
set -e

. ./request.sh

URL="https://${OPENWRT_HOSTNAME}/cgi-bin/luci/rpc/sys?auth=${OPENWRT_TOKEN}"

request "{ \"method\": \"uptime\" }"

uci_get_all_network.sh

#!/bin/sh
set -e

. ./request.sh

URL="https://${OPENWRT_HOSTNAME}/cgi-bin/luci/rpc/uci?auth=${OPENWRT_TOKEN}"

request "{ \"method\": \"get_all\", \"params\": [ \"network\" ] }"