LDWS General Endpoints

6 min

get /v1/ returns a list of all available apis request example get /api/v1/ http/1 1 host {{playerip}} authorization {{digestauth}} response example expand { "data" { "result" { "routes" \[ { "method" "get", "route" "/api/v1/health", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/download firmware", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/fw manifest url", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/info", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/time", "securitylevel" "informational" }, { "method" "put", "route" "/api/v1/time", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/video mode", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/logs", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/download log package", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/crash dump/ ", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/logs/crash dumps", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/logs/crash dumps/ ", "securitylevel" "informational" }, { "method" "put", "route" "/api/v1/control/reboot", "securitylevel" "controlmanagement" }, { "method" "put", "route" "/api/v1/control/dws password", "securitylevel" "controlmanagement" }, { "method" "get", "route" "/api/v1/control/dws password", "securitylevel" "controlmanagement" }, { "method" "get", "route" "/api/v1/control/local dws", "securitylevel" "controlmanagement" }, { "method" "put", "route" "/api/v1/control/local dws", "securitylevel" "controlmanagement" }, { "method" "get", "route" "/api/v1/files/ ", "securitylevel" "contentupload" }, { "method" "delete", "route" "/api/v1/files/ ", "securitylevel" "contentupload" }, { "method" "post", "route" "/api/v1/files/ ", "securitylevel" "contentupload" }, { "method" "put", "route" "/api/v1/files/ ", "securitylevel" "contentupload" }, { "method" "get", "route" "/api/v1/stored supervisors", "securitylevel" "contentupload" }, { "method" "put", "route" "/api/v1/remove supervisors", "securitylevel" "contentupload" }, { "method" "delete", "route" "/api/v1/clear supervisors", "securitylevel" "contentupload" }, { "method" "delete", "route" "/api/v1/storage/\ device", "securitylevel" "contentupload" }, { "method" "get", "route" "/api/v1/diagnostics", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/diagnostics/dns lookup/ ", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/diagnostics/ping/ ", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/diagnostics/trace route/ ", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/diagnostics/network neighborhood", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/diagnostics/network configuration/ ", "securitylevel" "informational" }, { "method" "put", "route" "/api/v1/diagnostics/network configuration/ ", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/diagnostics/interfaces", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/diagnostics/chromium debug", "securitylevel" "controlmanagement" }, { "method" "put", "route" "/api/v1/diagnostics/chromium debug", "securitylevel" "controlmanagement" }, { "method" "get", "route" "/api/v1/diagnostics/packet capture", "securitylevel" "controlmanagement" }, { "method" "post", "route" "/api/v1/diagnostics/packet capture", "securitylevel" "controlmanagement" }, { "method" "delete", "route" "/api/v1/diagnostics/packet capture", "securitylevel" "controlmanagement" }, { "method" "put", "route" "/api/v1/diagnostics/telnet", "securitylevel" "controlmanagement" }, { "method" "get", "route" "/api/v1/diagnostics/telnet", "securitylevel" "controlmanagement" }, { "method" "put", "route" "/api/v1/diagnostics/ssh", "securitylevel" "controlmanagement" }, { "method" "get", "route" "/api/v1/diagnostics/ssh", "securitylevel" "controlmanagement" }, { "method" "put", "route" "/api/v1/registry/recovery url", "securitylevel" "controlmanagement" }, { "method" "get", "route" "/api/v1/registry", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/registry/\ section", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/registry/\ section/\ key", "securitylevel" "informational" }, { "method" "put", "route" "/api/v1/registry/\ section/\ key", "securitylevel" "informational" }, { "method" "delete", "route" "/api/v1/registry/\ section/\ key", "securitylevel" "informational" }, { "method" "delete", "route" "/api/v1/registry/\ section", "securitylevel" "informational" }, { "method" "put", "route" "/api/v1/registry/flush", "securitylevel" "informational" }, { "method" "post", "route" "/api/v1/snapshot", "securitylevel" "controlmanagement" }, { "method" "get", "route" "/api/v1/video/\ connector/output/\ device", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/video/\ connector/output/\ device/edid", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/video/\ connector/output/\ device/power save", "securitylevel" "informational" }, { "method" "put", "route" "/api/v1/video/\ connector/output/\ device/power save", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/video/\ connector/output/\ device/modes", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/video/\ connector/output/\ device/mode", "securitylevel" "informational" }, { "method" "put", "route" "/api/v1/video/\ connector/output/\ device/mode", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/video/screen/modes", "securitylevel" "informational" }, { "method" "put", "route" "/api/v1/video/screen/modes", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/advanced/property lock", "securitylevel" "controlmanagement" }, { "method" "put", "route" "/api/v1/advanced/property lock", "securitylevel" "controlmanagement" }, { "method" "get", "route" "/api/v1/advanced/property lock", "securitylevel" "controlmanagement" }, { "method" "put", "route" "/api/v1/advanced/property lock", "securitylevel" "controlmanagement" }, { "method" "get", "route" "/api/v1/remoteview/config", "securitylevel" "controlmanagement" }, { "method" "put", "route" "/api/v1/remoteview/config", "securitylevel" "controlmanagement" }, { "method" "post", "route" "/api/v1/remoteview/\ source/view", "securitylevel" "controlmanagement" }, { "method" "get", "route" "/api/v1/remoteview/\ source/view", "securitylevel" "controlmanagement" }, { "method" "get", "route" "/api/v1/remoteview/\ source/view/\ id", "securitylevel" "controlmanagement" }, { "method" "delete", "route" "/api/v1/remoteview/\ source/view/\ id", "securitylevel" "controlmanagement" }, { "method" "get", "route" "/api/v1/system", "securitylevel" "internal" }, { "method" "get", "route" "/api/v1/system/service/\ id/ ", "securitylevel" "informational" }, { "method" "put", "route" "/api/v1/system/service/\ id/ ", "securitylevel" "informational" }, { "method" "delete", "route" "/api/v1/system/service/\ id/ ", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/system/supervisor/logging", "securitylevel" "controlmanagement" }, { "method" "put", "route" "/api/v1/system/supervisor/logging", "securitylevel" "controlmanagement" }, { "method" "get", "route" "/api/v1/system/supervisor/registration", "securitylevel" "internal" }, { "method" "put", "route" "/api/v1/system/supervisor/registration", "securitylevel" "internal" }, { "method" "put", "route" "/api/v1/system/supervisor/autorun settings update", "securitylevel" "internal" }, { "method" "get", "route" "/api/v1/system/supervisor/autorun config", "securitylevel" "internal" }, { "method" "post", "route" "/api/v1/system/supervisor/capabilities", "securitylevel" "internal" }, { "method" "get", "route" "/api/v1/legacy/lldp", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/debug", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/messages", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/dmesg", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/processes", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/smart report", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/ifconfig", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/lastring", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/lastkmsg", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/usb", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/network", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/netconfig", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/ptp", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/edid", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/script debug", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/network diagnostics", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/ping", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/dns lookup", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/traceroute", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/tcp connections", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/network statistics", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/registry dump", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/device data", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/avs", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/secure boot", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/extensions", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/crash dump present", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/dhcp server", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/contents", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/powersave", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/storage info", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/map", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/fd", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/block", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/zoneinfo", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/slabinfo", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/loadavg", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/meminfo", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/stat", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/vmstat", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/interrupts", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/version", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/boardid", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/packet capture", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/bvn", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/bvnall", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/edid raw", "securitylevel" "informational" }, { "method" "get", "route" "/api/v1/legacy/ca certificates", "securitylevel" "informational" } ] } } } get /v1/health/ returns information about the health of a player request example get /api/v1/health/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json response body status \string\ the player status the only possible value is "active" statustime \string\ the date and time the player responded to the status request the date/time is formatted as "yyyy mm dd hh\ mm\ ss \<timezone>" response example { "data" { "result" { "status" "active", "statustime" "2024 01 30 07 38 05 pst" } } } get /v1/download firmware downloads the os from the remote url to the player and then reboots the player to update the os query string parameter url \string\ the public url for downloading the firmware update file for your player model request example get /api/v1/download firmware/?url=https //bsncloud s3 amazonaws com/public/cobra 9 0 110 update bsfw http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json response body success \bool\ a flag indicating whether the download was successful reboot \bool\ a flag indicating whether the player will reboot when applying a firmware update response example { "data" { "result" { "success" true, "reboot" true } } }