LDWS Registry Endpoints

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 bool if the operation is successful value object object the keys are the names of the registry sections these are some examples brightscript string string the brightscript key value pairs networking string 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 string the name of the registry section key string 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 string the name of the registry section (for example, "html" or "networking") key string 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 string the name of the registry section (for example, "html" or "networking") key string 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 bool a flag indicating whether the registry key was deleted section string string this flag is set to the registry section key string 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 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 bool a flag indicating whether the registry section was deleted section string 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 bool a flag indicating whether the request was successfully read value string 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 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 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 bool a flag indicating whether the flush was successful response example { "data" { "result" { "success" true } } }