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 objectsuccess
bool: Whether or not the operation was successfulreboot
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 readpassword
Password{ }: A Password object that describes the DWS password. The following are possible values:isResultValid
bool: A flag indicating whether the DWS password is validisBlank
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: 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
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 setreboot
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 disabledv
alue
bool: Whentrue
means that the local DWS is enabled,false
is disabled
Response Example
{ "data": { "result": { "success": true, "value": true } } }
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
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": true }
Response Body
success
bool: A flag indicating whether the local DWS was successfully enabled or disabledreboot
bool: A flag indicating whether the player will reboot to enable/disable the local DWS
Response Example
{ "data": { "result": { "success": true, "reboot": true } } }