LDWS Diagnostics Endpoints

35 min

delete /v1/storage/\ device/ formats a storage device you must disable the autorun before reformatting the sd card on your device to disable the autorun, use the put /v1/control/reboot with body parameter {“autorun” ”disable”} , as described in this page docid\ ylxb9c8us70n09hookdp segment \ device \string\ the specified storage device (see this page docid\ bczooenmoifnrbeny6zki for a list of available devices) request body fs \string\ the file system docid\ nsjxffr7olfgdwgjfebme to use when reformatting a storage device the default value of fs is "exfat" request example delete /api/v1/storage/sd/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json, application/vnd bsn error+json content type application/json content length 49 this is the example request body { "fs" "exfat" } response example { "data" { "result" { "success" true, "output" "format completeted successfully ", "error" "" } } } get /v1/diagnostics/ runs network diagnostics on the player and returns the result in json format request example get /api/v1/diagnostics/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json response body for each of ethernet , wifi , modem , and internet diagnosis \string\ indicates if this type of interface is present log \object\[ ]\ this contains the diagnostic results for the interface name \string\ the name of the diagnostic test pass \bool\ indicates whether the test passed or not result \string\ the actual value for the diagnostic tests like checking type and ping ok \bool\ if diagnostics were run on the interface or not response example { "data" { "result" { "ethernet" { "diagnosis" "ok", "log" \[ { "name" "checking model networking support", "pass" true, "result" "" }, { "name" "checking for ethernet interface", "pass" true, "result" "" }, { "name" "checking interface type", "pass" true, "result" "ethernet" }, { "name" "checking ethernet link", "pass" true, "result" "" }, { "name" "checking ethernet ip address", "pass" true, "result" "" }, { "name" "checking ethernet netmask", "pass" true, "result" "" }, { "name" "checking ethernet gateway", "pass" true, "result" "ping 10/10 1375/1537/1623us" } ], "ok" true }, "wifi" { "diagnosis" "wifi interface not present", "log" \[ { "name" "checking model networking support", "pass" true, "result" "" }, { "name" "checking for wifi interface", "pass" false, "result" "wifi interface not present" } ], "ok" false }, "modem" { "diagnosis" "modem interface not present", "log" \[ { "name" "checking model networking support", "pass" true, "result" "" }, { "name" "checking for modem interface", "pass" false, "result" "modem interface not present" } ], "ok" false }, "internet" { "diagnosis" "ok", "log" \[ { "info" \[ "dns server 2600 1700\ dac0 2060 1 is not a valid ipv4 address" ], "name" "checking dns servers", "pass" true, "result" "at least one dns server is valid" }, { "info" \[ "dns pass/fail/timeout/mismatch udp 50/0/0/0 tcp 50/0/0/0" ], "name" "checking dns server (cached)", "pass" true, "result" "dns servers responded to 100% of potentially cached requests" }, { "info" \[ "dns pass/fail/timeout/mismatch udp 5/0/0/0 tcp 5/0/0/0" ], "name" "checking dns server (hopefully not cached)", "pass" true, "result" "dns servers responded to 100% of hopefully uncached requests" }, { "name" "checking internet connectivity", "pass" true, "result" "ping 10/10 87398/87760/88247us" }, { "name" "checking http", "pass" true, "result" "external ip is 76 218 104 224" }, { "name" "checking time server", "pass" true, "result" "" } ], "ok" true } } } } get /v1/diagnostics/dns lookup/\ address/ runs a dns lookup for an address, which can be a hostname or ip address segment \ address the hostname (for example, http //google com ) or ip address request example get /api/v1/diagnostics/dns lookup/google com/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json response body the player queries each dns field separately, then collects returned data into the records object, the tcp and udp connection information is in the server test object, and returned errors into the errorlist object records \object\ ipv4 \string\[ ]\ ipv4 addresses ipv6 \string\[ ]\ ipv6 addresses text \string\[ ]\ text records mx \object\[ ]\ mail exchange records exchange \string\ priority \int\ server test \object\ tcp \object\ made \int\ the total number of dns requests made pass \int\ the total number of requests that passed fail \int\ the total number of requests that failed timeout \int\ the total number of requests that timed out mismatch \int\ the total number of mismatched requests between the host and pointer records udp \object\ made \int\ the total number of dns requests made pass \int\ the total number of requests that passed fail \int\ the total number of requests that failed timeout \int\ the total number of requests that timed out mismatch \int\ the total number of mismatched requests between the host and pointer records errorlist \object\[ ]\ field \string\ the field ('ipv4', 'ipv6', 'cname', 'mx', 'service', or 'text') the error came from err \object\ errno \string\ error number (usually the same value as code) code \string\ error code number (see https //nodejs org/docs/latest v14 x/api/dns html#dns error codes https //nodejs org/docs/latest v14 x/api/dns html#dns error codes ) syscall \string\ information about the system call stack hostname \string\ the value passed in the url response example { "data" { "result" { "records" { "ipv4" \[ "142 250 105 113", "142 250 105 102", "142 250 105 139", "142 250 105 101", "142 250 105 138", "142 250 105 100" ], "ipv6" \[ "2607\ f8b0 4002\ c0c 8a", "2607\ f8b0 4002\ c0c 8b", "2607\ f8b0 4002\ c0c 71", "2607\ f8b0 4002\ c0c 64" ], "mx" \[ { "exchange" "smtp google com", "priority" 10 } ] }, "server test" { "tcp" { "made" 100, "pass" 100, "fail" 0, "timeout" 0, "mismatch" 0 }, "udp" { "made" 100, "pass" 100, "fail" 0, "timeout" 0, "mismatch" 0 } }, "errorlist" \[ { "field" "cname", "err" { "code" "enodata", "syscall" "querycname", "hostname" "google com" } }, { "field" "service", "err" { "code" "enodata", "syscall" "querysrv", "hostname" "google com" } }, { "field" "text", "err" { "code" "etimeout", "syscall" "querytxt", "hostname" "google com" } } ] } } } get /v1/diagnostics/ping/\ ipaddress/ pings the address passed in the request this does not work for hostnames, only for ip addresses segment \ ipaddress the specified ip address request example get /api/v1/diagnostics/ping/0 0 0 0/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json response body success \bool\ a flag that indicates if the operation succeeded or not response \object\ hostname \string\ the value that you passed in the url results \string\ ipv4 \object\[ ]\ address \string\ the ipv4 address that is pinged results \object\ received \int\ the number of packets received stats \object\ average \int\ the average time for the packet to return quickest \int\ the quickest time for the packet to return slowest \int\ the slowest time for the packet to return units \int\ the time units (usually microseconds) transmitted \int\ the number of packets transmitted ipv6 \object\[ ]\ this will only be returned if ipv6 is present interface \string\ source \string\ address \string\ the ipv6 address that is pinged results \object\ received \int\ the number of packets received transmitted \int\ the number of packets transmitted response example { "data" { "result" { "success" true, "response" { "hostname" "0 0 0 0", "results" { "ipv4" \[ { "address" "0 0 0 0", "results" { "received" 10, "stats" { "average" 318, "quickest" 223, "slowest" 336, "units" "us" }, "transmitted" 10 }, "up" true } ] }, "up" true } } } } get /v1/diagnostics/trace route/\ address/ runs trace route on the player you can optionally pass the boolean query parameter ?resolveaddress to resolve ip addresses in the result segment \ address the specified ip or hostname address query string parameter resolveaddress bool optional specifies whether the ip or hostname address should be resolved or not in the result request example get /api/v1/diagnostics/trace route/google com/?resolveaddress%3dtrue http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json response body address \string\ the ip address on which you are running the trace route results \object\ output \string\[ ]\ returns the trace route output information in text format protocol \string\ the ip protocol (for example, "ipv4" ) route \object\[ ]\ hop \int\ how many times the data moves from one router to the next servers \object\ address \string\ the address to which the trace route request is made hostname \string\ the server hostname stats \object\[ ]\ reachable \string\ time \string\ the time required for the trace route request to return units \string\ the time units (usually in milliseconds) response example { "data" { "result" { "address" "123 456 7 890", "resolveaddress" "true", "results" { "152 101 32 76" { "output" \[ "traceroute to 152 101 32 76 (152 101 32 76), 30 hops max, 46 byte packets", " 1 10 0 4 1 0 744 ms 0 458 ms 1 740 ms", " 2 192 168 0 1 1 738 ms 1 387 ms 1 387 ms", " 3 96 120 89 217 10 553 ms 11 250 ms 11 961 ms", " 4 96 110 176 145 11 958 ms 11 250 ms 9 845 ms", " 5 162 151 78 253 11 957 ms 13 366 ms 10 549 ms", " 6 96 108 99 249 13 366 ms 14 072 ms 20 414 ms", " 7 68 86 143 93 13 368 ms 11 960 ms 10 549 ms", " 8 96 97 98 246 32 397 ms 96 112 146 22 11 954 ms 69 241 75 42 9 841 ms", " 9 ", "10 152 101 32 76 10 452 ms 152 101 32 76 13 302 ms 152 101 32 76 12 649 ms", "11 192 178 105 102 11 948 ms 142 251 224 181 11 073 ms 192 178 46 198 17 759 ms", "12 142 251 32 46 11 955 ms 12 649 ms 10 543 ms" ], "protocol" "ipv4", "result" 0, "route" \[ { "error" "timeout", "hop" 9 } ] } } } } } get /v1/diagnostics/network neighborhood/ retrieves information about the player’s current network neighborhood (the other players on the same network) request example get /api/v1/diagnostics/network neighborhood/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json response body success \bool\ a flag that indicates if the operation succeeded response \object\[ ]\ an array of information about players in your network neighborhood chassis descr \string\ the model version, os version, serial number, etc chassis id \string\ a unique identifier for the player chassis name \string\ the name of the player mgmt ip \string\ port descr \string\ which interface the player is using port id \string\ vlan pvid \string\ if the diagnostic could not be performed, the response body may instead be an error message response example { "data" { "result" { "success" true, "response" \[ { "chassis descr" "brightsign xt1144 reve 8 5 47 uhe015005214", "chassis id" "90\ ac 3f 28\ fb\ a4", "chassis name" "brightsign uhe015005214", "mgmt ip" "2601 647 4500 1e5e 92ac 3fff\ fe28\ fba4", "port descr" "eth0", "port id" "90\ ac 3f 28\ fb\ a4", "vlan pvid" "0" } ] } } } get /v1/diagnostics/network configuration/\ interfacename/ gets the network configuration on the player see local dws apis docid 2zmel07w011h1267dt 59 for more information about digest authentication segment \ interfacename the network interface possible names include eth0 , wlan0 , and modem request example get /api/v1/diagnostics/network configuration/eth0/ http/1 1 host {{playerip}} authorization {{digestauth}} response body some entries (e g cacertificates , clientidentifier ) are identical for all interfaces text \string\ the network configuration information in plain text form output \output\ the network configuration information as a json object interfaces \interface\[ ]\ an array of interface objects representing network interfaces name \string\ the interface name (for example, "eth0" ) errors \error\[ ]\ an array of error messages associated with the interface params \param\[ ]\ an array of param objects representing parameters associated with the network interface each param interface has the following entries name \string\ the property name (e g "mac" ) value \string\ the property value (e g "90\ ac 3f 0b\ d2 88" ) host \info\[ ]\ an array of info objects providing network host information each object can have the following entries errors \error\[ ]\ an array of error messages associated with the network host params \param\[ ]\ an array of param objects representing parameters associated with the network host bsn \info\[ ]\ an array of info objects providing information about bsn communication other \info\[ ]\ an array of info objects providing information miscellaneous network information cacertificate \string\ \optional\ the contents of a ca certificate file in text form (i e a "pem" file) clientcertificate \bool\ \optional\ a flag indicating whether the player is using a client certificate clientidentifier \string\ \optional\ the dhcp client identifier for the network interface dnsserverlist \string\[ ]\ \optional\ an ip address list of the dns servers domain \string\ \optional\ the domain name for the network interface eaptlsoptions \string\ \optional\ a string containing eap specific options enabledprotocollist \string\[ ]\ \optional\ an array of enabled ip protocols currently supported values are "ipv4" and " ipv6" identity \string\ \optional\ the radius identity ipaddresslist \string\[ ]\ \optional\ the ip addresses assigned to the player inboundshaperrate \int\ \optional\ the bandwidth limit for inbound traffic in bits per second a value of 1 specifies the default bandwidth limit, and a value of 0 specifies no bandwidth limit (these two settings are functionally the same) metric \int\ \optional\ the routing metric for the default gateway on the interface routes with lower metrics are preferred over routes with higher metrics mtu \int\ \optional\ the maximum transmission unit (mtu) for the network interface in bytes privatekey \string\ \optional\ the private key for authentication vlanidlist \int\[ ]\ \optional\ an array of vlan ids that are supported on the parent network interface securitymode \string\ \optional\ security mode for authentication response example { "data" { "result" { "success" true, "response" \[ { "text" "\r\ninterface eth0\r\ntype wired\r\nlink yes\r\nconfiguration dhcp\r\nclient id brightsign\ re433d006644\r\nmac 90\ ac 3f 2a 01 79\r\ncurrent ip 192 168 1 174\r\nnetmask 255 255 255 0\r\nbroadcast 192 168 1 255\r\ngateway 192 168 1 254\r\nip6 address 2600 1700\ dac0 2060 43/128\r\nip6 address 2600 1700\ dac0 2060 92ac 3fff\ fe2a 179/64\r\nip6 address fe80 92ac 3fff\ fe2a 179/64\r\nmetric 0\r\ndomains attlocal net\r\ndns 192 168 1 254\r\n 2600 1700\ dac0 2060 1\r\nshape inbound no\r\n\r\nhost \r\nhost name brightsign re433d006644\r\nmdns host name brightsign re433d006644 local\r\ntime server http //time brightsignnetwork com\r\nproxy bypass \<none>\r\n\r\nbsn \r\ncrash url https //crashes brightsignnetwork com/bs/crashdump\r\nerror url https //handlers bsn cloud//bs/error ashx\r\nrecovery url https //handlers bsn cloud//recovery/recovery ashx\r\n\r\nother \r\nhttp port \r\n\r\n\r\n", "output" { "interfaces" \[ { "name" "eth0", "errors" \[], "params" \[ { "name" "type", "value" \[ "wired" ] }, { "name" "link", "value" \[ "yes" ] }, { "name" "configuration", "value" \[ "dhcp" ] }, { "name" "client id", "value" \[ "brightsign\ re433d006644" ] }, { "name" "mac", "value" \[ "90\ ac 3f 2a 01 79" ] }, { "name" "current ip", "value" \[ "192 168 1 174" ] }, { "name" "netmask", "value" \[ "255 255 255 0" ] }, { "name" "broadcast", "value" \[ "192 168 1 255" ] }, { "name" "gateway", "value" \[ "192 168 1 254" ] }, { "name" "ip6 address", "value" \[ "2600 1700\ dac0 2060 43/128" ] }, { "name" "ip6 address", "value" \[ "2600 1700\ dac0 2060 92ac 3fff\ fe2a 179/64" ] }, { "name" "ip6 address", "value" \[ "fe80 92ac 3fff\ fe2a 179/64" ] }, { "name" "metric", "value" \[ "0" ] }, { "name" "domains", "value" \[ "attlocal net" ] }, { "name" "dns", "value" \[ "192 168 1 254", "2600 1700\ dac0 2060 1" ] }, { "name" "shape inbound", "value" \[ "no" ] } ] } ], "host" \[ { "errors" \[], "params" \[ { "name" "host name", "value" \[ "brightsign re433d006644" ] }, { "name" "mdns host name", "value" \[ "brightsign re433d006644 local" ] }, { "name" "time server", "value" \[ "http //time brightsignnetwork com" ] }, { "name" "proxy bypass", "value" \[ "\<none>" ] } ] } ], "bsn" \[ { "errors" \[], "params" \[ { "name" "crash url", "value" \[ "https //crashes brightsignnetwork com/bs/crashdump" ] }, { "name" "error url", "value" \[ "https //handlers bsn cloud//bs/error ashx" ] }, { "name" "recovery url", "value" \[ "https //handlers bsn cloud//recovery/recovery ashx" ] } ] } ], "other" \[ { "errors" \[], "params" \[ { "name" "http port", "value" \[ "" ] } ] } ] } }, { "cacertificates" "", "clientcertificate" false, "clientidentifier" "brightsign\ re433d006644", "dnsserverlist" \[], "domain" "", "eaptlsoptions" "", "enabledprotocollist" \[ "ipv4", "ipv6" ], "identity" "", "ipaddresslist" \[], "metric" 0, "privatekey" false, "securitymode" "", "vlanidlist" \[] } ] } } } put /v1/diagnostics/network configuration/\ interfacename/ applies a test network configuration on the player you should use get to get the configuration parameters before setting it using this api the text and output parameters are not needed in put segment \ interfacename the network interface possible names include eth0 , wlan0 , and modem request body cacertificate \string\ \optional\ the contents of a ca certificate file in text form (i e a "pem" file) clientcertificate \bool\ \optional\ a flag indicating whether the player is using a client certificate clientidentifier \string\ \optional\ the dhcp client identifier for the network interface dnsserverlist \string\ \\[ ]\ \optional\ an ip address list of the dns servers domain \string\ \optional\ the domain name for the network interface eaptlsoptions \string\ \optional\ a string containing eap specific options enabledprotocollist \string\[ ]\ \optional\ an array of enabled ip protocols currently supported values are "ipv4" and "ipv6" identity \string\ \optional\ the radius identity ipaddresslist \string\[ ]\ \optional\ the ip addresses assigned to the player inboundshaperrate \int\ \optional\ the bandwidth limit for inbound traffic in bits per second a value of 1 specifies the default bandwidth limit, and a value of 0 specifies no bandwidth limit (these two settings are functionally the same) metric \int\ \optional\ the routing metric for the default gateway on the interface routes with lower metrics are preferred over routes with higher metrics mtu \int\ \optional\ the maximum transmission unit (mtu) for the network interface in bytes privatekey \string\ \optional\ the private key for authentication vlanidlist \int\[ ] \ \optional\ an array of vlan ids that are supported on the parent network interface securitymode \string\ \optional\ security mode for authentication request example the example request parameters and headers are set as follows put /api/v1/diagnostics/network configuration/eth0 http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json content type application/json content length 75 this is the example request body { "cacertificates" "", "clientcertificate" false, "clientidentifier" "brightsign\ d7e8cv332141", "dnsserverlist" \["192 168 86 1"], "domain" "lan", "eaptlsoptions" "", "enabledprotocollist" \[ "ipv4", "ipv6" ], "identity" "", "ipaddresslist" \[], "inboundshaperrate" 0, "metric" 1002, "privatekey" false, "securitymode" "", "vlanidlist" \[] } response example { "success" true, "reboot" true // indicates whether the player will reboot } get /v1/diagnostics/interfaces/ returns list of applied network interfaces on the player request body get /api/v1/diagnostics/interfaces/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json response body { "data" { "result" \[ "eth0", "ppp0" ] } } get /v1/diagnostics/packet capture/ returns the current status of packet capture operation request example get /api/v1/diagnostics/packet capture/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json response body statuscode \int\ the success or error code (200 is success) is running \bool\ flag indicating if the packet capture operation is running response example { "data" { "result" { "statuscode" 200, "is running" false } } } post /v1/diagnostics/packet capture/ starts a packet capture operation request body filename \string\ the name of the packet capture file if you don't pass this string, 'capture pcap' is the default net interface \string\ the name of the network interface for which we are performing packet capture 'eth0' is the default duration \int\ the duration for which the packet capture runs in seconds the default is 300 seconds (5 minutes) maxpackets \int\ the maximum number of packets to capture before concluding the process 0 is the default value snaplen \int\ the maximum size of each packet specifying 0 will instruct the function to capture the entire packet no matter the size filter \string\ a field for conditional filtering of packets this operation uses standard pcap syntax this string is empty by default request example post /api/v1/diagnostics/packet capture/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json content type application/json content length 190 this is the example request body { "filename" "capture pcap", "interface" "eth0", "duration" 300, "maxpackets" 0, "snaplen" 0, "filter" "" } response example { "data" { "result" { "statuscode" 200, "is running" true } } } delete /v1/diagnostics/packet capture/ stops a packet capture operation request example delete /api/v1/diagnostics/packet capture/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json response example { "data" { "result" { "statuscode" 200, "is running" false } } } get /v1/diagnostics/telnet/ returns information about whether or not telnet is enabled on the player, and the port number on which it is enabled if it is this is only available in bos 9 0 110 or 8 5 46 and above request example get /api/v1/diagnostics/telnet/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json response example a successful response is a 200 and this response body { "enabled" true, "portnumber" 23 } put /v1/diagnostics/telnet/ this is only available in bos 9 0 110 or 8 5 46 and above request body enabled \bool\ enable or disable telnet on the player portnumber \int\ the port number on which to enable telnet reboot \bool\ this optional parameter reboots the player immediately after executing this operation it is true by default request example the example request parameters and headers are set as follows put /api/v1/diagnostics/telnet/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json content type application/json content length 75 this is the example request body { "enabled" true "portnumber" "23" } response example { "success" true, "reboot" true } get /v1/diagnostics/ssh/ returns information about whether or not ssh is enabled on the player, and the port number on which it is enabled if it is this is only available in bos 9 0 110 or 8 5 46 and above request example the example request parameters and headers are set as follows get /api/v1/diagnostics/ssh/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json response example a successful response is a 200 and this response body { "enabled" true, "portnumber" 22, "password" true // indicates that a value is set } put /v1/diagnostics/ssh/ this is only available in bos 9 0 110 or 8 5 46 and above request body enabled \bool\ enable or disable ssh on the player portnumber \int\ the port number on which to enable ssh password \string\ sets the plain text login password for the ssh connection reboot \bool \ \optional\ reboots the player immediately after executing this operation it is true by default obfuscatedpassword \string \ \optional\ sets the login password for the ssh connection the password should previously have been obfuscated using a shared secret contact support\@brightsign biz mailto\ support\@brightsign biz to learn more about generating a key for obfuscation and storing it on the player request example the example request parameters and headers are set as follows put /api/v1/diagnostics/ssh/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json content type application/json content length 65 this is the example request body { "enabled" true, "portnumber" 22, "password" {{password}} } response example { "success" true, "reboot" true } get /v1/diagnostics/chromium debug/ returns whether the chromium web inspector has been set this api is only available as of bos 8 5 31 and later (see this page docid 4qlk1krr1cnx7xypwxry5 for more information) request example get /api/v1/diagnostics/chromium debug/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json response body enablewebinspector \bool\ whether the chromium web inspector is enabled for debugging html widgets response example a successful response is a 200 and this response body { "data" { "result" { "enablewebinspector" false } } } put /v1/diagnostics/chromium debug/ updates the chromium web inspector setting this api is only available as of bos 8 5 31 and later (see this page docid 4qlk1krr1cnx7xypwxry5 for more information) request body enablewebinspector \bool\ enable or disable the chromium web inspector for debugging html widgets requires a reboot to take effect request example the example request parameters and headers are set as follows put /api/v1/diagnostics/chromium debug/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json content type application/json content length 45 this is the example request body { "enablewebinspector" true } response body the server will return a success or error message a successful response will almost always cause a reboot which will be indicated in the response result \object\ the response object success \bool\ whether or not the operation was successful reboot \bool\ whether or not the player is rebooting response example { "data" { "result" { "success" true, "reboot" true } } }