...
GET /v1/
Returns a list of all available APIs.
Request Example
Code Block |
---|
GET /api/v1/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}} |
Response Example
Expand | |||||
---|---|---|---|---|---|
| |||||
|
GET /v1/health/
Returns information about the health of a player
Request Example
Code Block |
---|
GET /api/v1 |
...
/health/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json |
Response Body
status
string: The player status. The only possible value is "active".statusTime
string: The date and time the player responded to the status request. The date/time is formatted as"yyyy-mm-dd hh:mm:ss <timezone>"
.
Response Example
Code Block | ||
---|---|---|
| ||
{
"data": {
"result": {
"status": "active",
"statusTime": "2024-01-30 07:38:05 PST"
}
}
} |
GET /v1/download-firmware
Downloads the OS from the remote URL to the player and then
...
reboots the player to update the OS
...
.
Endpoints:
...
Query String Parameter
url
string: The public URL for downloading the firmware-update file for your player model
Request Example
Code Block |
---|
GET /api/v1/download-firmware/?url=https://bsncloud.s3.amazonaws.com/public/cobra-9.0.110-update.bsfw HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json |
Response Body
success
bool: A flag indicating whether the download was successfulreboot
bool: A flag indicating whether the player will reboot when applying a firmware update
Response Example
Code Block | ||
---|---|---|
| ||
{
"data": {
"result": {
"success": true,
"reboot": true
}
}
} |