LDWS API Control Endpoints

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)

This is the example request body:

Request Example (Disable Autorun)

This is the example request body:

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.

resultobject: The response object
- successbool: Whether or not the operation was successful
- rebootbool: Whether or not the player is rebooting

Response Examples

Crash Report

Factory Reset

Disable Autorun

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

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

PUT /v1/control/dws-password/

Resets or changes the DWS password.

Request Body

password string: This is the password value that you want to set. Passing a blank string "" will remove the existing password.
previous_password string: This optional parameter is the old password value

Request Example

This is the example request body:

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

GET /v1/control/local-dws/

Returns whether or not the local DWS is enabled.

Request Example

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

PUT /v1/control/local-dws/

Enables or disables the local DWS on the player.

Request Body

enable bool: Whether the local DWS is enabled or not (it is enabled by default)

Request Example

This is the example request body:

Response Body

success bool: A flag indicating whether the local DWS was successfully enabled or disabled
reboot bool: A flag indicating whether the player will reboot to enable/disable the local DWS

Response Example