LDWS Control Endpoints

18 min

put /v1/control/reboot/ reboots the player request body crash report \bool\ setting this parameter to true reboots the player and saves a crash report file to the brightsign dumps folder only use this when directed by brightsign customer service, which may request the crash report when helping you troubleshoot a player factory reset \bool\ setting this parameter to true resets the player to factory defaults, erasing all persistent registry settings for networking, security, and other applications autorun \string\ set to “disable” to disable the current autorun script, which is helpful for debugging purposes request example (simple reboot) this reboot has no body put /api/v1/control/reboot http/1 1 host {{playerip}} authorization {{digestauth}} request example (crash report) put /api/v1/control/reboot/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json content type application/json content length 36 this is the example request body { "crash report" true } request example (factory reset) put /api/v1/control/reboot/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json content type application/json content length 39 this is the example request body { "factory reset" true } request example (disable autorun) put /api/v1/control/reboot/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json content type application/json content length 41 this is the example request body { "autorun" "disable" } 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 examples crash report { "data" { "result" { "success" true, "message" "a reboot has been initiated (with crash report)" } } } factory reset { "data" { "result" { "success" true, "message" "a reboot has been initiated (with factory reset)" } } } disable autorun { "data" { "result" { "success" true, "message" "a reboot has been initiated" } } } get /v1/control/dws password/ returns information about the current password of the local dws (but not the password itself) such as whether the password is blank or invalid request example get /api/v1/control/dws password/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json response body success \bool\ a flag indicating whether the password was successfully read password \password{ }\ a password object that describes the dws password the following are possible values isresultvalid \bool\ a flag indicating whether the dws password is valid isblank \bool\ a flag indicating whether the dws password is blank (i e no password is required) response example { "data" { "result" { "success" true, "password" { "isresultvalid" true, "isblank" true } } } } put /v1/control/dws password/ resets or changes the dws password request body password \string\ the password value that you want to set previous password \string\ this optional parameter is the old password value obfuscated password \string\ an obfuscated password for the ldws request example put /api/v1/control/dws password/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json content type application/json content length 106 this is the example request body { "password" "newpassword", "previous password" "oldpassword" } response body success \bool\ a flag indicating whether the password was successfully set reboot \bool\ a flag indicating whether the player will reboot to set the password response example { "data" { "result" { "success" true, "reboot" false } } } get /v1/control/local dws/ returns whether or not the local dws is enabled request example get /api/v1/control/local dws/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json response body success \bool\ whether the local dws is enabled or disabled value \bool\ when true means that the local dws is enabled, false is disabled response example { "data" { "result" { "success" true, "value" true } } } put /v1/control/local dws/ used to disable the local dws see access the local dws docid\ iafcherljfjdjtwttkpk5 for information on enabling the local dws using other methods request body enable \bool\ whether or not the local dws is enabled request example put /api/v1/control/local dws/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json content type application/json content length 47 this is the example request body { "enable" false } response body success \bool\ a flag indicating whether the local dws was successfully disabled reboot \bool\ a flag indicating whether the player will reboot to disable the local dws response example { "data" { "result" { "success" true, "reboot" true } } } put /v1/control/ssh host keys/reset/ resets the ssh host keys by regenerating new host key pairs this is useful for security purposes or when host keys have been compromised the system will automatically determine if a reboot is required, unless overriden by the reboot parameter request example put /api/v1/control/ssh host keys/reset/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json content type application/json content length 56 request body this is the optional example request body { "reboot" "true" } response example { "data" { "result" { "success" true, "value" true } } } put /v1/control/dws default certs/reset/ resets the dws default certificates by regenerating new certificate pairs this is useful for security purposes or when certificates have been compromised the system will reboot to activate new certificates, unless overriden by the reboot parameter request example put /api/v1/control/dws default certs/reset/ http/1 1 host {{playerip}} authorization {{digestauth}} accept application/json content type application/json content length 56 request body this is the optional example request body { "reboot" "true" } response example { "data" { "result" { "success" true, "value" true } } }