rDWS Registry Endpoints

base url for these endpoints https //ws bsn cloud/rest/v1/ get /registry/ returns the player registry dump request example get /rest/v1/registry/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+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 object object the brightscript key value pairs networking object object the networking key value pairs response example { "route" "/v1/registry", "method" "get", "data" { "result" { "success" true, "value" { "autorun" { "bootchecks" "", "bootstrap" "", "knowngood" "", "lasttried" "" }, "brightscript" { "createdby" "supervisor 2 1 10" }, "networking" { "a" "janedoetesting", "access token" "jcqvlxy3ttpgpc5iiwl7wmhibkkcldjkuralgwbqyvcjdi2jyrjhddjahqrngkm9b9wabdb2ktqqcc02okja7ejzmfp1jyllrbdfrscxbxepr4wtv3tryoiwtv8trgvb", "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 /registry/\ section/\ key/ returns a particular registry section or key value segment 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 this example gets the telnet port number from the networking section get /rest/v1/registry/networking/telnet?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} response example { "route" "/v1/registry/brightscript/g", "method" "get", "data" { "result" { "success" true, "section" "brightscript", "key" "g", "value" "" } } } put /registry/\ section/\ key/ sets a value in the specified section of the registry 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 you type to avoid putting the player in an unstable state segment 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 this example sets the telnet port number in the networking section of registry put /rest/v1/registry/networking/telnet?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} content type application/json content length 47 this is the example request body { "data" { "value" 23 } } response example { "data" { "result" { "success" true, "section" "networking", "key" "telnet", "value" "23" } }, "route" "/v1/registry/networking/telnet", "method" "put" } delete /registry/\ section/\ key/ deletes a key value pair from the specified registry section, or the whole section applications rely on the values they have set in the registry please be mindful of what you type to avoid putting the player in an unstable state segment 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 this example deletes the telnet key from the networking section of registry delete /rest/v1/registry/networking/telnet?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} response example { "route" "/v1/registry/networking/telnet", "method" "delete", "data" { "result" { "success" true, "section" "networking", "key" "telnet" } } } put /registry/flush/ flush the registry immediately to disk this is available as of bos 9 0 110 and 8 5 47 if you are on an earlier os, you can reboot the player to flush the registry request example put /rest/v1/registry/flush?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} response example { "route" "/v1/registry/flush", "method" "put", "data" { "result" { "success" true } } } get /registry/recovery url/ retrieves the recovery url stored in the player registry request example get /rest/v1/registry/recovery url/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json response body success bool bool a flag indicating whether the request was successfully read value string string the recovery url response example { "route" "/v1/registry/recovery url", "method" "get", "data" { "result" { "success" true, "value" "https //handlers bsn cloud//recovery/recovery ashx" } } } put /registry/recovery url/ writes a new recovery url to the player registry request body url string string the new recovery url request example put /rest/v1/registry/recovery url/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 61 this is the example request body { "data" { "url" "https //test com" } } response body success bool bool a flag indicating whether the write was successful response example { "data" { "result" { "success" true } }, "route" "/v1/registry/recovery url", "method" "put" }