rDWS Control Endpoints

base url for these endpoints https //ws bsn cloud/rest/v1/ put /control/reboot/ reboots the player the player will not send a response to a reboot request request body crash report bool bool setting to true reboots the player and save a crash report file to the brightsign dumps folder you should use this only when directed by brightsign customer service, which may need the crash report when helping you troubleshoot a player factory reset bool bool setting to true resets the player to the factory defaults, erasing all persistent registry settings for networking, security, and other applications autorun string string setting to disable disables the current autorun script (this is helpful for debugging) request example (simple reboot) this request has no body put /rest/v1/control/reboot/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json request example (crash report) put /rest/v1/control/reboot/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 56 this is the example request body { "data" { "crash report" true } } request example (factory reset) put /rest/v1/control/reboot/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 57 this is the example request body { "data" { "factory reset" true } } request example (disable autorun) put /rest/v1/control/reboot/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 56 this is the example request body { "data" { "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 object the response object success bool bool whether or not the operation was successful reboot bool 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)" } }, "route" "/v1/control/reboot", "method" "put" } factory reset { "data" { "result" { "success" true, "message" "a reboot has been initiated (with factory reset)" } }, "route" "/v1/control/reboot", "method" "put" } disable autorun { "data" { "result" { "success" true, "message" "a reboot has been initiated" } }, "route" "/v1/control/reboot", "method" "put" } get /control/dws password/ retrieves 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 /rest/v1/control/dws password/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body success bool bool a flag indicating whether the password was successfully read password password{ } password{ } a password object that describes the dws password the following are possible values isresultvalid bool bool a flag indicating whether the dws password is valid isblank bool bool a flag indicating whether the dws password is blank (i e no password is required) response example { "route" "/v1/control/dws password", "method" "get", "data" { "result" { "success" true, "password" { "isresultvalid" true, "isblank" true } } } } put /control/dws password/ sets a new password for the local dws (or removes the password requirement on older bos versions) request body password string string the new local dws password for the player as of bos 9 0 128 and bos 9 1 75, this api enforces strong password requirements, so passing in an empty string will cause an error as of bos 9 0 128 and bos 9 1 75, this api enforces strong password requirements, so passing in an empty string will cause an error in older bos versions, t in older bos versions, t he absence of this parameter (or a blank string) removes the password requirement for the dws he absence of this parameter (or a blank string) removes the password requirement for the dws previous password string string the previous dws password this parameter must be included this value can be an empty string to indicate that the previous password was blank request example put /rest/v1/control/dws password/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 106 this is the example request body { 	"data" { 	 "password" "newpassword", 	 "previous password" "oldpassword" 	} } response body success bool bool a flag indicating whether the password was successfully set reboot bool bool a flag indicating whether the player will reboot to set the password response example { "data" { "result" { "success" true, "reboot" false } }, "route" "/v1/control/dws password", "method" "put" } get /control/local dws/ retrieves the current state of the local dws request example get /rest/v1/control/local dws/?destinationtype=player\&destinationname=27d33c000051 http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body success bool bool a flag indicating whether the local dws is enabled or disabled response example { "route" "/v1/control/local dws", "method" "get", "data" { "result" { "success" true, "value" true } } } put /control/local dws/ enables or disables the local dws request body enable bool bool a flag indicating whether the local dws should be enabled or disabled request example put /rest/v1/control/local dws/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 50 this is the example request body { "data" { "enable" true } } response body success bool bool a flag indicating whether the local dws was successfully enabled or disabled reboot bool bool a flag indicating whether the player will reboot to enable/disable the local dws response example { "data" { "result" { "success" true, "reboot" true } }, "route" "/v1/control/local dws", "method" "put" } put /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 /rest/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 { "data" { "reboot" "true" } } response example { "data" { "result" { "success" true, "value" true } } } put /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 /rest/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 { "data" { "reboot" "true" } } response example { "data" { "result" { "success" true, "value" true } } }