Page Comparison

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

title	Expand

Code Block

language	json

{ "data": { "result": {

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

title	Expand

Code Block

language	json

{
  "data": {
    "result": {
      "routes": [
        {
          "method": "GET",
          "route": "/api/v1/health",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/download-firmware",
          "securityLevel": "Informational"
       "routes": [ },
        {
          "method": "GET",
          "route": "/api/v1/healthfw-manifest-url",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/download-firmwareinfo",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/fw-manifest-urltime",
          "securityLevel": "Informational"
        },
        {
          "method": "GETPUT",
          "route": "/api/v1/infotime",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/timevideo-mode",
          "securityLevel": "Informational"
        },
        {
          "method": "PUTGET",
          "route": "/api/v1/timelogs",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/videodownload-log-modepackage",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/logscrash-dump/*",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/download-log-packagelogs/crash-dumps",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/logs/crash-dumpdumps/*",
          "securityLevel": "Informational"
        },
        {
          "method": "GETPUT",
          "route": "/api/v1/logscontrol/crash-dumpsreboot",
          "securityLevel": "InformationalControlManagement"
        },
        {
          "method": "GETPUT",
          "route": "/api/v1/logscontrol/crashdws-dumps/*password",
          "securityLevel": "InformationalControlManagement"
        },
        {
          "method": "PUTGET",
          "route": "/api/v1/control/rebootdws-password",
          "securityLevel": "ControlManagement"
        },
        {
          "method": "PUTGET",
          "route": "/api/v1/control/local-dws-password",
          "securityLevel": "ControlManagement"
        },
        {
          "method": "GETPUT",
          "route": "/api/v1/control/local-dws-password",
          "securityLevel": "ControlManagement"
        },
        {
          "method": "GET",
          "route": "/api/v1/controlfiles/local-dws*",
          "securityLevel": "ControlManagementContentUpload"
        },
        {
          "method": "PUTDELETE",
          "route": "/api/v1/controlfiles/local-dws*",
          "securityLevel": "ControlManagementContentUpload"
        },
        {
          "method": "GETPOST",
          "route": "/api/v1/files/*",
          "securityLevel": "ContentUpload"
        },
        {
          "method": "DELETEPUT",
          "route": "/api/v1/files/*",
          "securityLevel": "ContentUpload"
        },
        {
          "method": "POSTGET",
          "route": "/api/v1/files/*stored-supervisors",
          "securityLevel": "ContentUpload"
        },
        {
          "method": "PUT",
          "route": "/api/v1/files/*remove-supervisors",
          "securityLevel": "ContentUpload"
        },
        {
          "method": "GETDELETE",
          "route": "/api/v1/storedclear-supervisors",
          "securityLevel": "ContentUpload"
        },
        {
          "method": "PUTDELETE",
          "route": "/api/v1/remove-supervisors/storage/:device",
          "securityLevel": "ContentUpload"
        },
        {
          "method": "DELETEGET",
          "route": "/api/v1/clear-supervisorsdiagnostics",
          "securityLevel": "ContentUploadInformational"
        },
        {
          "method": "DELETEGET",
          "route": "/api/v1/diagnostics/storage/:devicedns-lookup/*",
          "securityLevel": "ContentUploadInformational"
        },
        {
          "method": "GET",
          "route": "/api/v1/diagnostics/ping/*",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/diagnostics/dnstrace-lookuproute/*",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/diagnostics/ping/*network-neighborhood",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/diagnostics/tracenetwork-routeconfiguration/*",
          "securityLevel": "Informational"
        },
        {
          "method": "GETPUT",
          "route": "/api/v1/diagnostics/network-neighborhoodconfiguration/*",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/diagnostics/network-configuration/*interfaces",
          "securityLevel": "Informational"
        },
        {
          "method": "PUTGET",
          "route": "/api/v1/diagnostics/networkchromium-configuration/*debug",
          "securityLevel": "InformationalControlManagement"
        },
        {
          "method": "GETPUT",
          "route": "/api/v1/diagnostics/interfaceschromium-debug",
          "securityLevel": "InformationalControlManagement"
        },
        {
          "method": "GET",
          "route": "/api/v1/diagnostics/chromiumpacket-debugcapture",
          "securityLevel": "ControlManagement"
        },
        {
          "method": "PUTPOST",
          "route": "/api/v1/diagnostics/chromiumpacket-debugcapture",
          "securityLevel": "ControlManagement"
        },
        {
          "method": "GETDELETE",
          "route": "/api/v1/diagnostics/packet-capture",
          "securityLevel": "ControlManagement"
        },
        {
          "method": "POSTPUT",
          "route": "/api/v1/diagnostics/packet-capturetelnet",
          "securityLevel": "ControlManagement"
        },
        {
          "method": "DELETEGET",
          "route": "/api/v1/diagnostics/packet-capturetelnet",
          "securityLevel": "ControlManagement"
        },
        {
          "method": "PUT",
          "route": "/api/v1/diagnostics/telnetssh",
          "securityLevel": "ControlManagement"
        },
        {
          "method": "GET",
          "route": "/api/v1/diagnostics/telnetssh",
          "securityLevel": "ControlManagement"
        },
        {
          "method": "PUT",
          "route": "/api/v1/diagnosticsregistry/sshrecovery_url",
          "securityLevel": "ControlManagement"
        },
        {
          "method": "GET",
          "route": "/api/v1/diagnostics/sshregistry",
          "securityLevel": "ControlManagementInformational"
        },
        {
          "method": "PUTGET",
          "route": "/api/v1/registry/recovery_url:section",
          "securityLevel": "ControlManagementInformational"
        },
        {
          "method": "GET",
          "route": "/api/v1/registry/:section/:key",
          "securityLevel": "Informational"
        },
        {
          "method": "GETPUT",
          "route": "/api/v1/registry/:section/:key",
          "securityLevel": "Informational"
        },
        {
          "method": "GETDELETE",
          "route": "/api/v1/registry/:section/:key",
          "securityLevel": "Informational"
        },
        {
          "method": "PUTDELETE",
          "route": "/api/v1/registry/:section/:key",
          "securityLevel": "Informational"
        },
        {
          "method": "DELETEPUT",
          "route": "/api/v1/registry/:section/:keyflush",
          "securityLevel": "Informational"
        },
        {
          "method": "DELETEPOST",
          "route": "/api/v1/registry/:sectionsnapshot",
          "securityLevel": "InformationalControlManagement"
        },
        {
          "method": "PUTGET",
          "route": "/api/v1/video/:connector/registryoutput/flush:device",
          "securityLevel": "Informational"
        },
        {
          "method": "POSTGET",
          "route": "/api/v1/snapshot/video/:connector/output/:device/edid",
          "securityLevel": "ControlManagementInformational"
        },
        {
          "method": "GET",
          "route": "/api/v1/video/:connector/output/:device/power-save",
          "securityLevel": "Informational"
        },
        {
          "method": "GETPUT",
          "route": "/api/v1/video/:connector/output/:device/edidpower-save",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/video/:connector/output/:device/power-savemodes",
          "securityLevel": "Informational"
        },
        {
          "method": "PUTGET",
          "route": "/api/v1/video/:connector/output/:device/power-savemode",
          "securityLevel": "Informational"
        },
        {
          "method": "GETPUT",
          "route": "/api/v1/video/:connector/output/:device/modesmode",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/video/:connector/output/:device/modescreen/modes",
          "securityLevel": "Informational"
        },
        {
          "method": "PUT",
          "route": "/api/v1/video/:connector/output/:device/modescreen/modes",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/video/screen/modesadvanced/property-lock",
          "securityLevel": "InformationalControlManagement"
        },
        {
          "method": "PUT",
          "route": "/api/v1/video/screen/modesadvanced/property-lock",
          "securityLevel": "InformationalControlManagement"
        },
        {
          "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/advancedremoteview/property-lockconfig",
          "securityLevel": "ControlManagement"
        },
        {
          "method": "PUT",
          "route": "/api/v1/advancedremoteview/property-lockconfig",
          "securityLevel": "ControlManagement"
        },
        {
          "method": "GETPOST",
          "route": "/api/v1/remoteview/:source/configview",
          "securityLevel": "ControlManagement"
        },
        {
          "method": "PUTGET",
          "route": "/api/v1/remoteview/:source/configview",
          "securityLevel": "ControlManagement"
        },
        {
          "method": "POSTGET",
          "route": "/api/v1/remoteview/:source/view/:id",
          "securityLevel": "ControlManagement"
        },
        {
          "method": "GETDELETE",
          "route": "/api/v1/remoteview/:source/view/:id",
          "securityLevel": "ControlManagement"
        },
        {
          "method": "GET",
          "route": "/api/v1/remoteview/:source/view/:id/system",
          "securityLevel": "ControlManagementInternal"
        },
        {
          "method": "DELETEGET",
          "route": "/api/v1/remoteview/:source/viewsystem/service/:id/*",
          "securityLevel": "ControlManagementInformational"
        },
        {
          "method": "GETPUT",
          "route": "/api/v1/system/service/:id/*",
          "securityLevel": "InternalInformational"
        },
        {
          "method": "GETDELETE",
          "route": "/api/v1/system/service/:id/*",
          "securityLevel": "Informational"
        },
        {
          "method": "PUTGET",
          "route": "/api/v1/system/service/:id/*supervisor/logging",
          "securityLevel": "InformationalControlManagement"
        },
        {
          "method": "DELETEPUT",
          "route": "/api/v1/system/service/:id/*supervisor/logging",
          "securityLevel": "InformationalControlManagement"
        },
        {
          "method": "GET",
          "route": "/api/v1/system/supervisor/loggingregistration",
          "securityLevel": "ControlManagementInternal"
        },
        {
          "method": "PUT",
          "route": "/api/v1/system/supervisor/loggingregistration",
          "securityLevel": "ControlManagementInternal"
        },
        {
          "method": "GETPUT",
          "route": "/api/v1/system/supervisor/registrationautorun-settings-update",
          "securityLevel": "Internal"
        },
        {
          "method": "PUTGET",
          "route": "/api/v1/system/supervisor/registrationautorun-config",
          "securityLevel": "Internal"
        },
        {
          "method": "PUTPOST",
          "route": "/api/v1/system/supervisor/autorun-settings-updatecapabilities",
          "securityLevel": "Internal"
        },
        {
          "method": "GET",
          "route": "/api/v1/system/supervisor/autorun-configlegacy/lldp",
          "securityLevel": "InternalInformational"
        },
        {
          "method": "POSTGET",
          "route": "/api/v1/systemlegacy/supervisor/capabilitiesdebug",
          "securityLevel": "InternalInformational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/lldpmessages",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/debugdmesg",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/messagesprocesses",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/dmesgsmart_report",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/processesifconfig",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/smart_reportlastring",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/ifconfiglastkmsg",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/lastringusb",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/lastkmsgnetwork",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/usbnetconfig",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/networkptp",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/netconfigedid",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/ptpscript_debug",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/edidnetwork_diagnostics",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/script_debugping",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/networkdns_diagnosticslookup",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/pingtraceroute",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/dnstcp_lookupconnections",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/traceroutenetwork_statistics",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/tcpregistry_connectionsdump",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/networkdevice_statisticsdata",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/registry_dumpavs",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/devicesecure_databoot",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/avsextensions",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/securecrash_dump_bootpresent",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/extensionsdhcp-server",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/crash_dump_presentcontents",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/dhcp-serverpowersave",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/contentsstorage_info",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/powersavemap",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/storage_infofd",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/mapblock",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/fdzoneinfo",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/blockslabinfo",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/zoneinfoloadavg",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/slabinfomeminfo",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/loadavgstat",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/meminfovmstat",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/statinterrupts",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/vmstatversion",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/interruptsboardid",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/versionpacket_capture",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/boardidbvn",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/packet_capturebvnall",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/bvnedid_raw",
          "securityLevel": "Informational"
        },
        {
          "method": "GET",
          "route": "/api/v1/legacy/bvnallca_certificates",
          "securityLevel": "Informational"
        },
      ]
 {   }
       "method": "GET",
          "route": "}
}

Endpoints:

Table of Contents

minLevel	1
maxLevel	2
outline	false
style	none
type	list
printable	false

GET /v1/health/

Returns information about the health of a player

Request Example

Code Block
GET /api/v1/

legacy

health/

edid_raw", "securityLevel": "Informational" }, { "method": "GET",

 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

language	json

{
  "data": {
    "result": {

route

status": "

/api/v1/legacy/ca_certificates

active",

securityLevel

statusTime": "

Informational"

2024-01-30 07:38:05 PST"

] } } }

Endpoints:

Table of ContentsminLevel1maxLevel2outlinefalsestylenonetypelistprintablefalse

}
}

GET /v1/

health/

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

Code Block
GET /api/v1/health//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".
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>".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

language	json

{
  "data": {
    "result": {
      "statussuccess": "active"true,
      "statusTimereboot": "2024-01-30 07:38:05 PST"true
      }
  }
}

GET /v1/download-firmware

The OS file is downloaded from the remote URL to the player and then player is rebooted, updating the OS in the process.

Versions Compared

Old Version 5

New Version 6

Key

GET /v1/

Request Example

Response Example

GET /v1/

Request Example

Response Example

Endpoints:

GET /v1/health/

Request Example

Response Body

Response Example

Endpoints:

GET /v1/

download-firmware

Query String Parameter

Request Example

Response Body

Response Example

GET /v1/download-firmware