...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
GET /v1/registry/
Returns the entire registry dump. The hidden registry sections are not returned in this response.
Request Example
The example request parameters and headers are set as follows:
Code Block |
---|
GET /api/v1/registry/ HTTP/1.1
Host: {{player_ip_address}}
Authorization: {{DigestAuth}}
Accept: application/json |
Response Body
success
bool: If the operation is successful
value
object: The keys are the names of the registry sections. These are some examples:
Response Example
...
...
...
GET /v1/registry/
Returns the entire registry dump. The hidden registry sections are not returned in this response.
Request Example
The example request parameters and headers are set as follows:
Code Block |
---|
GET /api/v1/registry/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json |
Response Body
success
bool: If the operation is successful
value
object: The keys are the names of the registry sections. These are some examples:
Response Example
Expand |
---|
|
Code Block |
---|
| {
"data": {
"result": {
"success": true,
|
|
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
JcqVLXY3Ttpkpc5IiWL7wMHibKKcLDJkuRaLgWBQyvcjdI2JYRjHDdjaHQrnGkm9b9wAbdb2kTqqCC02oKjA7EJZMfP1jyllrbdFrscXbXePr4WtV3TRYoiWtv8tRGVB",
" |
|
...
access_token_expiration": " |
|
...
...
access_token_expires_at": " |
|
...
Thu Feb 08 2024 07:47:26 GMT-0800 (Pacific Standard Time)",
" |
|
...
...
...
...
...
...
...
brightwallscreennumber": " |
|
...
...
...
/bs/batteryCharger.ashx",
" |
|
...
bsn_settings_last_modified": "Tue, 30 Jan 2024 22:01:45 GMT",
" |
|
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
enablewpaenterpriseauthentication": " |
|
...
...
...
...
url": "https://certs.bsn.cloud/ |
|
...
...
...
...
...
bp3": "https://certs.bsn.cloud/ |
|
...
...
...
...
...
...
...
...
...
bsn_classic_server": "https:// |
|
...
...
...
...
...
...
...
...
...
...
...
endpoints_certsserver": "https:/ |
|
...
...
...
...
...
https://certs.bsn.cloud/echo/ping",
" |
|
...
endpoints_failsafecheck": "https:/ |
|
...
...
certs.bsn.cloud/features/api/v1/failsafe",
" |
|
...
endpoints_featuresavailable": " |
|
...
https://certs.bsn.cloud/features/api/v1/features",
" |
|
...
endpoints_provisionserver": "provision.bsn.cloud",
" |
|
...
endpoints_remote_storage_notifications": " |
|
...
https://certs.bsn.cloud/files/api/v1/notify",
" |
|
...
...
...
...
...
https://certs.bsn.cloud/files/api/v1/verify",
" |
|
...
endpoints_s3_classic_url": " |
|
...
...
/bsnm.s3.amazonaws.com/public/",
" |
|
...
...
https://bsncloud.s3.amazonaws.com/public/",
" |
|
...
endpoints_supervisorupgrade": " |
|
...
https://certs.bsn.cloud/features/api/v1/supervisors",
" |
|
...
endpoints_websocketsdws": " |
|
...
...
...
/bs/error.ashx",
"g": "Default",
"hh": "/bs/heartbeat.ashx",
"hr": "no",
"hwr": "True",
"internalcapackages": "",
"isc": "FF702896",
"last_modified_autorun_settings_at": "2024-01-30T22:01:45.000Z",
"lastbsnconnectiontime": "2024/01/30 10:57:50.864",
"lwr": "True",
"mwr": "True",
" |
|
...
...
...
...
{\"hostname\":\"BrightSign-RE433D006644\",\"proxyServer\":null,\"proxyBypass\":[],\"timeServers\":[\"http://time.brightsignnetwork.com\"],\"interfaces\":[{\"enabled\":true,\"proto\":\"DHCP\",\"ip\":null,\"gateway\":null,\"dns\":null,\"rateLimitDuringInitialDownloads\":0,\"rateLimitInsideContentDownloadWindow\":0,\"rateLimitOutsideContentDownloadWindow\":null,\"contentDownloadEnabled\":true,\"textFeedsDownloadEnabled\":true,\"mediaFeedsDownloadEnabled\":true,\"healthReportingEnabled\":true,\"logsUploadEnabled\":true,\"name\":\"eth0\",\"type\":\"Ethernet\",\"metric\":100}]}",
" |
|
...
...
...
...
...
...
...
...
...
...
bs/checkforcontent.ashx",
" |
|
...
...
...
...
...
...
...
...
LUi0ZRpbz1BWJ3JuBCwMPtRxEMQ9vMwyTRokUSENNCRckFOuVTUshtfb7Lk5H3Ji8kTyBsqVlwo9SZjzwkHv6V9XKKX4mtwbvGWWlYgUslOK7UbURW3zeMGKWhxbIghx",
" |
|
...
...
...
...
Fri Feb 06 2026 07:47:26 GMT-0800 (Pacific Standard Time)",
" |
|
...
...
...
...
...
...
...
...
...
...
...
...
...
...
/recovery/recovery_runsetup_ba.brs",
"ru": "/recovery/recovery.ashx",
"schedule_handler_duration": "21600",
"settings_handler_duration": "21600",
"sle": "no",
"status_handler_duration": "300",
"sut": "BSN",
"tbh": " 300",
"tbnc": " 21600",
"td": "/bs/trafficdownload.ashx",
"ts": "http://time.brightsignnetwork.com",
"twr": "True",
"tz": "PST",
"u": "",
"uab": "no",
"uat": "no",
"ub": "https://handlers.bsn.cloud/",
"ud": "Trying again",
"ul": "/bs/uploadlogs.ashx",
"un": "XD5",
"unm": "appendUnitIDToUnitName",
"up": "no",
"ut": " 0",
"v": "1",
"version": "3.0.0",
"vle": "no",
"vu": "/bs/events.ashx",
"wifi": "no"
},
"newsection": {
"newkey": "newvalue"
}
}
}
}
} |
|
GET /v1/registry/:section/:key/
Returns a particular key value for a specified section and key.
Segment Values
section
string: The name of the registry section
key
string: The name of the registry key
Request Example
The example request parameters and headers are set as follows:
section
is set to html
key
is set to use-brightsign-media-player
Code Block |
---|
GET /api/v1/registry/html/use-brightsign-media-player/ |
...
HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json |
Response Example
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
PUT /v1/registry/:section/:key/
Creates registry values. Do a GET first to see which keys are available.
Note |
---|
Applications rely on the values they have set in the registry. Please be mindful of what registry keys you update to avoid putting the player in an unstable state. |
Segment Values
section
string: The name of the registry section (for example, "html" or "networking")
key
string: The name of the registry key
Request Example
The example request parameters and headers are set as follows:
section
is set to html
key
is set to use-brightsign-media-player
Code Block |
---|
PUT /api/v1/registry/html/use-brightsign-media-player/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Content-Type: application/json
Content-Length: 33 |
This is the example request body:
Code Block |
---|
|
{
"value": "0"
} |
Response Example
Code Block |
---|
|
{
"data": {
"result": {
|
...
...
...
...
...
...
use-brightsign-media-player",
|
...
...
...
Endpoints:
Table of Contents |
---|
minLevel | 1 |
---|
maxLevel | 2 |
---|
outline | false |
---|
style | none |
---|
type | list |
---|
printable | false |
---|
|
GET /v1/registry/:section/:key/
...
DELETE /v1/registry/:section/:key/
Remove the specified registry values.
Note |
---|
Applications rely on the values they have set in the registry. Please be mindful of what registry keys you delete to avoid putting the player in an unstable state. |
Segment Values
section
string: The name of the registry section (for example, "html" or "networking")
key
string: The name of the registry
...
Request Example
The example request parameters and headers are set as follows:
section
is set to html
key
is set to use-brightsign-media-player
...
DELETE /api/v1/registry/html/use-brightsign-media-player/ HTTP/ |
...
1.1
Host: {{playerIP}}
Authorization: {{ |
...
DigestAuth}}
Accept: application/json |
...
PUT /v1/registry/:section/:key/
Creates registry values. Do a GET first to see which keys are available.
Note |
---|
Applications rely on the values they have set in the registry. Please be mindful of what registry keys you update to avoid putting the player in an unstable state. |
Segment Values
section
string: The name of the registry section (for example, "html" or "networking")
key
string: The name of the registry key
Request Example
The example request parameters and headers are set as follows:
section
is set to html
key
is set to use-brightsign-media-player
...
Response Body
success
bool: A flag indicating whether the registry key was deleted
section
string: This flag is set to the registry section
key
string: This flag is set to the registry key
Response Example
Code Block |
---|
|
{
"data": {
"result": {
"success": true,
"section": "html",
"key": "use-brightsign-media-player |
...
...
...
...
...
...
This is the example request body:
Code Block |
---|
|
{
"value": "0"
} |
DELETE /v1/registry/:section/:key/
Remove the specified registry values.
Note |
---|
Applications rely on the values they have set in the registry. Please be mindful of what registry keys you delete to avoid putting the player in an unstable state. |
Segment Values
section
string: The name of the registry section (for example, "html" or "networking")
key
string: The name of the registry key
Request Example
The example request parameters and headers are set as follows:
section
is set to html
key
is set to use-brightsign-media-player
Code Block |
---|
DELETE /api/v1/registry/html/use-brightsign-media-player/ HTTP/1.1
Host: {{player_ip_address}}
Accept: application/json |
DELETE /v1/registry/:section/
Deletes an entire registry section
Request Example
The example request parameters and headers are set as follows:
section
is set to test_section
...
DELETE /v1/registry/:section/
Deletes an entire registry section
Segment
section
string: The name of the registry section (for example, "html" or "networking")
Request Example
The example request parameters and headers are set as follows:
section
is set to test_section
Code Block |
---|
DELETE /api/v1/registry/test_section/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json |
Response Body
success
bool: A flag indicating whether the registry section was deleted
section
string: This flag is set to the registry section
Response Example
Code Block |
---|
|
{
"data": {
"result": {
"success": true,
"section": "test_section"
}
}
} |
GET /v1/registry/recovery_url/
Retrieves the recovery URL stored in the player registry
Request Example
recovery_url
is the recovery URL in the player registry
Code Block |
---|
GET /api/v1/registry/recovery_url/ HTTP/1.1
Host: {{ |
...
playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json |
Response Body
success
bool: A flag indicating whether the request was successfully read
...
value
string: The recovery URL
Response Example
Code Block |
---|
|
{
"data": {
"result": {
"success": true,
"value": "https://handlers.bsn.cloud//recovery/recovery.ashx"
}
}
} |
PUT /v1/registry/recovery_url/
Updates the recovery URL in the player’s registry.
Request Body
url
string: The value of the recovery URL
Request Example
The example request parameters and headers are set as follows:
url
is set to www.google.com
Code Block |
---|
PUT /api/v1/registry/recovery_url/ HTTP/1.1
Host: {{ |
...
playerIP}}
Authorization: {{DigestAuth}}}
Accept: application/json
Content-Type: application/json
Content |
...
Request Body
Request Body
Code Block |
---|
|
{
"url": "www.google.com"
} |
Response Body
success
bool: A flag indicating whether the write was successful
Response Example
...
...