LDWS Registry Endpoints

24 min

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:

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:
- brightscript string: The BrightScript key-value pairs
- networking string: The networking key-value pairs

Response Example

{
  "data": {
    "result": {
      "success": true,
      "value": {
        "autorun": {
          "bootchecks": "",
          "bootstrap": "",
          "knowngood": "",
          "lasttried": ""
        },
        "brightscript": {
          "createdby": "Supervisor 2.1.10"
        },
        "networking": {
          "a": "JaneDoeTesting",
          "access_token": "JcqVLXY3Ttpkpc5IiWL7wMHibKKcLDJkuRaLgWBQyvcjdI2JYRjHDdjaHQrnGkm9b9wAbdb2kTqqCC02oKjA7EJZMfP1jyllrbdFrscXbXePr4WtV3TRYoiWtv8tRGVB",
          "access_token_expiration": "86400",
          "access_token_expires_at": "Thu Feb 08 2024 07:47:26 GMT-0800 (Pacific Standard Time)",
          "bbhf": "true",
          "bph": "[]",
          "brightwallname": "",
          "brightwallscreennumber": "",
          "bs": "/bs/batteryCharger.ashx",
          "bsn_settings_last_modified": "Tue, 30 Jan 2024 22:01:45 GMT",
          "bsnapiversion": "2022/06",
          "cdr": "no",
          "createdby": "Supervisor 2.1.10",
          "cwr": "True",
          "dd": "/bs/devicedownload.ashx",
          "de": "/bs/deviceerror.ashx",
          "dhcp": "yes",
          "dle": "no",
          "dp": "/bs/devicedownloadprogress.ashx",
          "dwse": "true",
          "dwsp": "",
          "ele": "no",
          "enableremotesnapshot": "no",
          "enablewpaenterpriseauthentication": "False",
          "endpoints_blessings_installer_url": "https://certs.bsn.cloud/install-blessing/v1/",
          "endpoints_blessings_server_bp3": "https://certs.bsn.cloud/blessings/",
          "endpoints_bsn_classic_api_server": "http://api.brightsignnetwork.com",
          "endpoints_bsn_classic_server": "https://services.brightsignnetwork.com",
          "endpoints_bsnapiserver": "https://api.bsn.cloud",
          "endpoints_bsnserver": "https://handlers.bsn.cloud",
          "endpoints_certsserver": "https://certs.bsn.cloud",
          "endpoints_echotest": "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",
          "endpoints_remote_storage_server": "https://certs.bsn.cloud/files/api/v1/verify",
          "endpoints_s3_classic_url": "http://bsnm.s3.amazonaws.com/public/",
          "endpoints_s3url": "https://bsncloud.s3.amazonaws.com/public/",
          "endpoints_supervisorupgrade": "https://certs.bsn.cloud/features/api/v1/supervisors",
          "endpoints_websocketsdws": "wss://ws.bsn.cloud/",
          "eu": "/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",
          "ncp": "0",
          "networkjson": "{\"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}]}",
          "nlws": "s",
          "nlwseun": "yes",
          "nlwsp": "",
          "nlwsu": "",
          "nu": "/bs/checkforcontent.ashx",
          "p": "",
          "ple": "no",
          "rdwse": "yes",
          "refresh_token": "LUi0ZRpbz1BWJ3JuBCwMPtRxEMQ9vMwyTRokUSENNCRckFOuVTUshtfb7Lk5H3Ji8kTyBsqVlwo9SZjzwkHv6V9XKKX4mtwbvGWWlYgUslOK7UbURW3zeMGKWhxbIghx",
          "refresh_token_expires_at": "Fri Feb 06 2026 07:47:26 GMT-0800 (Pacific Standard Time)",
          "registered_with_bsn": "yes",
          "rlmid": "unlimited",
          "rlmiw": "unlimited",
          "rlmow": "default",
          "rlrid": "0",
          "rlriw": "0",
          "rlrow": "0",
          "rs": "/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

GET /api/v1/registry/html/use-brightsign-media-player/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}
Accept: application/json

Response Example

{
  "data": {
    "result": {
      "success": true,
      "section": "brightscript",
      "key": "g",
      "value": ""
    }
  }
}

PUT /v1/registry/:section/:key/

Creates registry values. Do a GET first to see which keys are available.

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

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:

{
   "value": "0"
}

Response Example

{
  "data": {
    "result": {
      "success": true,
      "section": "html",
      "key": "use-brightsign-media-player",
      "value": "23"
    }
  }
}

DELETE /v1/registry/:section/:key/

Remove the specified registry values.

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 value

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

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

{
  "data": {
    "result": {
      "success": true,
      "section": "html",
      "key": "use-brightsign-media-player"
    }
  }
}

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

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

{
  "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

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

{
  "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

PUT /api/v1/registry/recovery_url/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}}
Accept: application/json
Content-Type: application/json
Content-Length: 37

Request Body

{
   "url": "www.google.com"
}

Response Body

success bool: A flag indicating whether the write was successful

Response Example

{
  "data": {
    "result": {
      "success": true
    }
  }
}

PUT /v1/registry/flush/

Flushes the contents of the player’s registry immediately to persistent storage. This endpoint is only available in BOS 9.0.107 and 8.5.46 and later.

Request Example

The example request parameters and headers are set as follows:

PUT /api/v1/registry/flush/ HTTP/1.1
Host: {{playerIP}}
Authorization: {{DigestAuth}}}
Accept: application/json

Response Body

success bool: A flag indicating whether the flush was successful

Response Example

{
  "data": {
    "result": {
      "success": true
    }
  }
}