...
...
...
...
...
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
...
...
...
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 |
|---|
|
| Code Block |
|---|
| {
"data": {
"result": {
"routes": [
{
"method": "GET",
"route": "/api/v1/health",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/download-firmware",
"securityLevel": "Informational"
|
|
...
},
{
"method": "GET",
"route": "/api/v1/ |
|
...
fw-manifest-url",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/ |
|
...
info",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/ |
|
...
time",
"securityLevel": "Informational"
},
{
"method": " |
|
...
...
time",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/ |
|
...
video-mode",
"securityLevel": "Informational"
},
{
"method": " |
|
...
...
logs",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/ |
|
...
...
package",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/ |
|
...
crash-dump/*",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/ |
|
...
logs/crash-dumps",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/logs/crash- |
|
...
dumps/*",
"securityLevel": "Informational"
},
{
"method": " |
|
...
...
...
reboot",
"securityLevel": " |
|
...
ControlManagement"
},
{
"method": " |
|
...
...
...
...
password",
"securityLevel": " |
|
...
ControlManagement"
},
{
"method": " |
|
...
GET",
"route": "/api/v1/control/ |
|
...
dws-password",
"securityLevel": "ControlManagement"
},
{
"method": " |
|
...
GET",
"route": "/api/v1/control/local-dws |
|
...
",
"securityLevel": "ControlManagement"
},
{
"method": " |
|
...
PUT",
"route": "/api/v1/control/local-dws |
|
...
",
"securityLevel": "ControlManagement"
},
{
"method": "GET",
"route": "/api/v1/ |
|
...
...
...
ContentUpload"
},
{
"method": " |
|
...
DELETE",
"route": "/api/v1/ |
|
...
...
...
ContentUpload"
},
{
"method": " |
|
...
POST",
"route": "/api/v1/files/*",
"securityLevel": "ContentUpload"
},
{
"method": " |
|
...
PUT",
"route": "/api/v1/files/*",
"securityLevel": "ContentUpload"
},
{
"method": " |
|
...
...
stored-supervisors",
"securityLevel": "ContentUpload"
},
{
"method": "PUT",
"route": "/api/v1/ |
|
...
remove-supervisors",
"securityLevel": "ContentUpload"
},
{
"method": " |
|
...
DELETE",
"route": "/api/v1/ |
|
...
clear-supervisors",
"securityLevel": "ContentUpload"
},
{
"method": " |
|
...
DELETE",
"route": "/api/v1/ |
|
...
storage/:device",
"securityLevel": "ContentUpload"
},
{
"method": " |
|
...
...
diagnostics",
"securityLevel": " |
|
...
Informational"
},
{
"method": " |
|
...
...
diagnostics/dns-lookup/*",
"securityLevel": " |
|
...
Informational"
},
{
"method": "GET",
"route": "/api/v1/diagnostics/ping/*",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/diagnostics/ |
|
...
...
route/*",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/diagnostics/ |
|
...
network-neighborhood",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/diagnostics/ |
|
...
...
configuration/*",
"securityLevel": "Informational"
},
{
"method": " |
|
...
PUT",
"route": "/api/v1/diagnostics/network- |
|
...
configuration/*",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/diagnostics/ |
|
...
interfaces",
"securityLevel": "Informational"
},
{
"method": " |
|
...
GET",
"route": "/api/v1/diagnostics/ |
|
...
...
debug",
"securityLevel": " |
|
...
ControlManagement"
},
{
"method": " |
|
...
PUT",
"route": "/api/v1/diagnostics/ |
|
...
chromium-debug",
"securityLevel": " |
|
...
ControlManagement"
},
{
"method": "GET",
"route": "/api/v1/diagnostics/ |
|
...
...
capture",
"securityLevel": "ControlManagement"
},
{
"method": " |
|
...
POST",
"route": "/api/v1/diagnostics/ |
|
...
...
capture",
"securityLevel": "ControlManagement"
},
{
"method": " |
|
...
DELETE",
"route": "/api/v1/diagnostics/packet-capture",
"securityLevel": "ControlManagement"
},
{
"method": " |
|
...
PUT",
"route": "/api/v1/diagnostics/ |
|
...
telnet",
"securityLevel": "ControlManagement"
},
{
"method": " |
|
...
GET",
"route": "/api/v1/diagnostics/ |
|
...
telnet",
"securityLevel": "ControlManagement"
},
{
"method": "PUT",
"route": "/api/v1/diagnostics/ |
|
...
ssh",
"securityLevel": "ControlManagement"
},
{
"method": "GET",
"route": "/api/v1/diagnostics/ |
|
...
ssh",
"securityLevel": "ControlManagement"
},
{
"method": "PUT",
"route": "/api/v1/ |
|
...
...
recovery_url",
"securityLevel": "ControlManagement"
},
{
"method": "GET",
"route": "/api/v1/ |
|
...
registry",
"securityLevel": " |
|
...
Informational"
},
{
"method": " |
|
...
GET",
"route": "/api/v1/registry/ |
|
...
:section",
"securityLevel": " |
|
...
Informational"
},
{
"method": "GET",
"route": "/api/v1/registry/:section/:key",
"securityLevel": "Informational"
},
{
"method": " |
|
...
PUT",
"route": "/api/v1/registry/:section/:key",
"securityLevel": "Informational"
},
{
"method": " |
|
...
DELETE",
"route": "/api/v1/registry/:section/:key",
"securityLevel": "Informational"
},
{
"method": " |
|
...
DELETE",
"route": "/api/v1/registry/:section |
|
...
",
"securityLevel": "Informational"
},
{
"method": " |
|
...
PUT",
"route": "/api/v1/registry/ |
|
...
flush",
"securityLevel": "Informational"
},
{
"method": " |
|
...
POST",
"route": "/api/v1/ |
|
...
snapshot",
"securityLevel": " |
|
...
ControlManagement"
},
{
"method": " |
|
...
GET",
"route": "/api/v1/video/:connector/ |
|
...
...
:device",
"securityLevel": "Informational"
},
{
"method": " |
|
...
...
/video/:connector/output/:device/edid",
"securityLevel": " |
|
...
Informational"
},
{
"method": "GET",
"route": "/api/v1/video/:connector/output/:device/power-save",
"securityLevel": "Informational"
},
{
"method": " |
|
...
PUT",
"route": "/api/v1/video/:connector/output/:device/ |
|
...
power-save",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/video/:connector/output/:device/ |
|
...
modes",
"securityLevel": "Informational"
},
{
"method": " |
|
...
GET",
"route": "/api/v1/video/:connector/output/:device/ |
|
...
mode",
"securityLevel": "Informational"
},
{
"method": " |
|
...
PUT",
"route": "/api/v1/video/:connector/output/:device/ |
|
...
mode",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/video/ |
|
...
screen/modes",
"securityLevel": "Informational"
},
{
"method": "PUT",
"route": "/api/v1/video/ |
|
...
screen/modes",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/ |
|
...
advanced/property-lock",
"securityLevel": " |
|
...
ControlManagement"
},
{
"method": "PUT",
"route": "/api/v1/ |
|
...
advanced/property-lock",
"securityLevel": " |
|
...
ControlManagement"
},
{
"method": "GET",
"route": "/api/v1/advanced/property-lock",
"securityLevel": "ControlManagement"
},
{
"method": "PUT",
"route": "/api/v1/advanced/property-lock",
"securityLevel": "ControlManagement"
},
{
"method": "GET",
"route": "/api/v1/ |
|
...
...
config",
"securityLevel": "ControlManagement"
},
{
"method": "PUT",
"route": "/api/v1/ |
|
...
...
config",
"securityLevel": "ControlManagement"
},
{
"method": " |
|
...
POST",
"route": "/api/v1/remoteview/ |
|
...
...
view",
"securityLevel": "ControlManagement"
},
{
"method": " |
|
...
GET",
"route": "/api/v1/remoteview/:source/ |
|
...
view",
"securityLevel": "ControlManagement"
},
{
"method": " |
|
...
GET",
"route": "/api/v1/remoteview/:source/view/:id",
"securityLevel": "ControlManagement"
},
{
"method": " |
|
...
DELETE",
"route": "/api/v1/remoteview/:source/view/:id",
"securityLevel": "ControlManagement"
},
{
"method": "GET",
"route": "/api/v1/ |
|
...
system",
"securityLevel": " |
|
...
Internal"
},
{
"method": " |
|
...
...
...
...
:id/*",
"securityLevel": " |
|
...
Informational"
},
{
"method": " |
|
...
PUT",
"route": "/api/v1/system/service/:id/*",
"securityLevel": " |
|
...
Informational"
},
{
"method": " |
|
...
DELETE",
"route": "/api/v1/system/service/:id/*",
"securityLevel": "Informational"
},
{
"method": " |
|
...
GET",
"route": "/api/v1/system/ |
|
...
supervisor/logging",
"securityLevel": " |
|
...
ControlManagement"
},
{
"method": " |
|
...
PUT",
"route": "/api/v1/system/ |
|
...
supervisor/logging",
"securityLevel": " |
|
...
ControlManagement"
},
{
"method": "GET",
"route": "/api/v1/system/supervisor/ |
|
...
registration",
"securityLevel": " |
|
...
Internal"
},
{
"method": "PUT",
"route": "/api/v1/system/supervisor/ |
|
...
registration",
"securityLevel": " |
|
...
Internal"
},
{
"method": " |
|
...
PUT",
"route": "/api/v1/system/supervisor/ |
|
...
autorun-settings-update",
"securityLevel": "Internal"
},
{
"method": " |
|
...
GET",
"route": "/api/v1/system/supervisor/ |
|
...
autorun-config",
"securityLevel": "Internal"
},
{
"method": " |
|
...
POST",
"route": "/api/v1/system/supervisor/ |
|
...
capabilities",
"securityLevel": "Internal"
},
{
"method": "GET",
"route": "/api/v1/ |
|
...
legacy/lldp",
"securityLevel": " |
|
...
Informational"
},
{
"method": " |
|
...
...
...
debug",
"securityLevel": " |
|
...
Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
messages",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
dmesg",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
processes",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
smart_report",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
ifconfig",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
lastring",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
lastkmsg",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
usb",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
network",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
netconfig",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
ptp",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
edid",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
script_debug",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
network_diagnostics",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
ping",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
...
lookup",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
traceroute",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
...
connections",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
network_statistics",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
...
dump",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
...
data",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
avs",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
...
boot",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
extensions",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
...
present",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
dhcp-server",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
contents",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
powersave",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
storage_info",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
map",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
fd",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
block",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
zoneinfo",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
slabinfo",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
loadavg",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
meminfo",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
stat",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
vmstat",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
interrupts",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
version",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
boardid",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
packet_capture",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
bvn",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
bvnall",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
edid_raw",
"securityLevel": "Informational"
},
{
"method": "GET",
"route": "/api/v1/legacy/ |
|
...
ca_certificates",
"securityLevel": "Informational"
} |
|
...
...
...
GET /v1/health/
Returns information about the health of a player
Request Example
...
...
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": {
|
...
...
...
...
...
...
...
...
...
Endpoints:
...
GET /v1/
...
Returns information about the health of a player
download-firmware
Downloads the OS from the remote URL to the player and then reboots the player to update the OS.
Query String Parameter
url string: The public URL for downloading the firmware-update file for your player model
Request Example
...
/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
...
status string: The player status. The only possible value is "active".
...
success bool: A flag indicating whether the download was successful
reboot bool: A flag indicating whether the player will reboot when applying a firmware update
Response Example
| Code Block |
|---|
|
{
"data": {
"result": {
" |
...
...
...
...
...
...
GET /v1/download-firmware
...