Cloud APIs
...
B-Deploy/Provisioning APIs
Version 2.0 B-Deploy Endpoints
B-Deploy Setup Endpoints (v2)
11min
these endpoints allow users to automatically provision brightsign players over the internet base url for these endpoints https //provision bsn cloud/rest setup/v2/setup/ get retrieves player setups for your network and username from the b deploy server url parameters username string string the username of the player setups to retrieve networkname string string required required the unique identifier of the network request example username is set to janedoe\@brightsign biz networkname is set to janedoenetwork get /rest setup/v2/setup/?username=janedoe\@brightsign biz\&networkname=janedoenetwork http/1 1 host provision bsn cloud content type application/json authorization {{bearer token}} success response 200 200 contains total int int the total number of player setups that belong to the b deploy account matched int int the number of player setups contained in the response devicesetups devicesetup devicesetup \[ ] \[ ] the device setup entity (v2) docid\ b1xzcru3ltg9cdz1ynqb6 success response example { "error" null, "result" \[ { " id" "1234567890", "username" "janedoe\@brightsign biz", "client" "bacon", "packagename" "newtimezone", "setuptype" "bsn", "networkname" "janedoenetwork", "devicename" "series 5", "devicedescription" "", "bsngroupname" "default", "setupjson" "{\\"version\\" \\"2 0 0\\",\\" id\\" \\"6605edbcdc8ec3658c0d45ea\\",\\"bdeploy\\" {\\"username\\" \\"janedoe\@brightsign biz\\",\\"networkname\\" \\"janedoenetwork\\",\\"client\\" \\"bacon\\",\\"packagename\\" \\"newtimezone\\"},\\"firmwareupdatesbyfamily\\" {\\"impala\\" {\\"firmwareupdatesource\\"\ null,\\"firmwareupdatesourcefilepath\\" \\"\\",\\"firmwareupdatesourceurl\\" \\"\\",\\"firmwareupdatestandardtargetfilename\\" \\"impala update bsfw\\",\\"firmwareupdatedifferenttargetfilename\\" \\"impala update different bsfw\\",\\"firmwareupdatenewertargetfilename\\" \\"impala update newer bsfw\\",\\"firmwareupdatesavetargetfilename\\" \\"impala update save bsfw\\",\\"firmwareupdateversion\\" \\"\\",\\"productionreleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/impala 8 5 47 update bsfw\\",\\"betareleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/impala 8 5 47 update bsfw\\",\\"compatiblereleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/impala 8 0 146 update bsfw\\",\\"productionversion\\" \\"8 5 47\\",\\"betaversion\\" \\"8 5 47\\",\\"compatibleversion\\" \\"8 0 146\\",\\"productionversionnumber\\" 525615,\\"betaversionnumber\\" 525615,\\"compatibleversionnumber\\" 524434,\\"productionreleasesha1\\" \\"4dcf3e2dae41d05e49f3bc6a8ed49925d1cbb75a\\",\\"betareleasesha1\\" \\"4dcf3e2dae41d05e49f3bc6a8ed49925d1cbb75a\\",\\"compatiblereleasesha1\\" \\"789cf557fbb0a5f70ecc103e5d071186b57eb38f\\",\\"productionreleasefilelength\\" 144788480,\\"betareleasefilelength\\" 144788480,\\"compatiblereleasefilelength\\" 137811964,\\"existingfwcontentid\\" \\"\\"},\\"pantera\\" {\\"firmwareupdatesource\\"\ null,\\"firmwareupdatesourcefilepath\\" \\"\\",\\"firmwareupdatesourceurl\\" \\"\\",\\"firmwareupdatestandardtargetfilename\\" \\"pantera update bsfw\\",\\"firmwareupdatedifferenttargetfilename\\" \\"pantera update different bsfw\\",\\"firmwareupdatenewertargetfilename\\" \\"pantera update newer bsfw\\",\\"firmwareupdatesavetargetfilename\\" \\"pantera update save bsfw\\",\\"firmwareupdateversion\\" \\"\\",\\"productionreleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/pantera 8 5 47 update bsfw\\",\\"betareleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/pantera 8 5 47 update bsfw\\",\\"compatiblereleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/pantera 8 0 146 update bsfw\\",\\"productionversion\\" \\"8 5 47\\",\\"betaversion\\" \\"8 5 47\\",\\"compatibleversion\\" \\"8 0 146\\",\\"productionversionnumber\\" 525615,\\"betaversionnumber\\" 525615,\\"compatibleversionnumber\\" 524434,\\"productionreleasesha1\\" \\"ee9ef5265c5ff85c77e4a87f264f8cf1112225ed\\",\\"betareleasesha1\\" \\"ee9ef5265c5ff85c77e4a87f264f8cf1112225ed\\",\\"compatiblereleasesha1\\" \\"58196ad8707b6e62185f1aba6d124ed1adfa7f67\\",\\"productionreleasefilelength\\" 144337538,\\"betareleasefilelength\\" 144337538,\\"compatiblereleasefilelength\\" 137509058,\\"existingfwcontentid\\" \\"\\"},\\"tiger\\" {\\"firmwareupdatesource\\"\ null,\\"firmwareupdatesourcefilepath\\" \\"\\",\\"firmwareupdatesourceurl\\" \\"\\",\\"firmwareupdatestandardtargetfilename\\" \\"tiger update bsfw\\",\\"firmwareupdatedifferenttargetfilename\\" \\"tiger update different bsfw\\",\\"firmwareupdatenewertargetfilename\\" \\"tiger update newer bsfw\\",\\"firmwareupdatesavetargetfilename\\" \\"tiger update save bsfw\\",\\"firmwareupdateversion\\" \\"\\",\\"productionreleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/tiger 8 5 47 update bsfw\\",\\"betareleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/tiger 8 5 47 update bsfw\\",\\"compatiblereleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/tiger 8 0 146 update bsfw\\",\\"productionversion\\" \\"8 5 47\\",\\"betaversion\\" \\"8 5 47\\",\\"compatibleversion\\" \\"8 0 146\\",\\"productionversionnumber\\" 525615,\\"betaversionnumber\\" 525615,\\"compatibleversionnumber\\" 524434,\\"productionreleasesha1\\" \\"45df4348e6ce1039fa54f8a3fa3bf0e6e95dacca\\",\\"betareleasesha1\\" \\"45df4348e6ce1039fa54f8a3fa3bf0e6e95dacca\\",\\"compatiblereleasesha1\\" \\"f02173d13f800d8d264d761226f783baa27b44b2\\",\\"productionreleasefilelength\\" 156481838,\\"betareleasefilelength\\" 156481838,\\"compatiblereleasefilelength\\" 147734484,\\"existingfwcontentid\\" \\"\\"},\\"pagani\\" {\\"firmwareupdatesource\\"\ null,\\"firmwareupdatesourcefilepath\\" \\"\\",\\"firmwareupdatesourceurl\\" \\"\\",\\"firmwareupdatestandardtargetfilename\\" \\"pagani update bsfw\\",\\"firmwareupdatedifferenttargetfilename\\" \\"pagani update different bsfw\\",\\"firmwareupdatenewertargetfilename\\" \\"pagani update newer bsfw\\",\\"firmwareupdatesavetargetfilename\\" \\"pagani update save bsfw\\",\\"firmwareupdateversion\\" \\"\\",\\"productionreleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/pagani 8 5 47 update bsfw\\",\\"betareleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/pagani 8 5 47 update bsfw\\",\\"compatiblereleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/pagani 8 0 146 update bsfw\\",\\"productionversion\\" \\"8 5 47\\",\\"betaversion\\" \\"8 5 47\\",\\"compatibleversion\\" \\"8 0 146\\",\\"productionversionnumber\\" 525615,\\"betaversionnumber\\" 525615,\\"compatibleversionnumber\\" 524434,\\"productionreleasesha1\\" \\"8dd2ede70c9095392fb30e031b9376922af98528\\",\\"betareleasesha1\\" \\"8dd2ede70c9095392fb30e031b9376922af98528\\",\\"compatiblereleasesha1\\" \\"9af7416c055f9fe45d3b492ad00a7cb8b0e5f7ff\\",\\"productionreleasefilelength\\" 190350854,\\"betareleasefilelength\\" 190350854,\\"compatiblereleasefilelength\\" 167649562,\\"existingfwcontentid\\" \\"\\"},\\"malibu\\" {\\"firmwareupdatesource\\"\ null,\\"firmwareupdatesourcefilepath\\" \\"\\",\\"firmwareupdatesourceurl\\" \\"\\",\\"firmwareupdatestandardtargetfilename\\" \\"malibu update bsfw\\",\\"firmwareupdatedifferenttargetfilename\\" \\"malibu update different bsfw\\",\\"firmwareupdatenewertargetfilename\\" \\"malibu update newer bsfw\\",\\"firmwareupdatesavetargetfilename\\" \\"malibu update save bsfw\\",\\"firmwareupdateversion\\" \\"\\",\\"productionreleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/malibu 8 5 47 update bsfw\\",\\"betareleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/malibu 8 5 47 update bsfw\\",\\"compatiblereleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/malibu 8 0 146 update bsfw\\",\\"productionversion\\" \\"8 5 47\\",\\"betaversion\\" \\"8 5 47\\",\\"compatibleversion\\" \\"8 0 146\\",\\"productionversionnumber\\" 525615,\\"betaversionnumber\\" 525615,\\"compatibleversionnumber\\" 524434,\\"productionreleasesha1\\" \\"5358940fe1aa6742aa8a9e0f82c1920991476867\\",\\"betareleasesha1\\" \\"5358940fe1aa6742aa8a9e0f82c1920991476867\\",\\"compatiblereleasesha1\\" \\"b897e81655879cc0cf7a73fad79aa615cb17da31\\",\\"productionreleasefilelength\\" 191643784,\\"betareleasefilelength\\" 191643784,\\"compatiblereleasefilelength\\" 178140054,\\"existingfwcontentid\\" \\"\\"},\\"sebring\\" {\\"firmwareupdatesource\\"\ null,\\"firmwareupdatesourcefilepath\\" \\"\\",\\"firmwareupdatesourceurl\\" \\"\\",\\"firmwareupdatestandardtargetfilename\\" \\"sebring update bsfw\\",\\"firmwareupdatedifferenttargetfilename\\" \\"sebring update different bsfw\\",\\"firmwareupdatenewertargetfilename\\" \\"sebring update newer bsfw\\",\\"firmwareupdatesavetargetfilename\\" \\"sebring update save bsfw\\",\\"firmwareupdateversion\\" \\"\\",\\"productionreleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/sebring 8 5 47 update bsfw\\",\\"betareleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/sebring 8 5 47 update bsfw\\",\\"compatiblereleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/sebring 8 2 17 3 update bsfw\\",\\"productionversion\\" \\"8 5 47\\",\\"betaversion\\" \\"8 5 47\\",\\"compatibleversion\\" \\"8 2 17 3\\",\\"productionversionnumber\\" 525615,\\"betaversionnumber\\" 525615,\\"compatibleversionnumber\\" 524817,\\"productionreleasesha1\\" \\"8c14e14c01251e6dae32bba286b3bf79ec34cffa\\",\\"betareleasesha1\\" \\"8c14e14c01251e6dae32bba286b3bf79ec34cffa\\",\\"compatiblereleasesha1\\" \\"399b5dd4203a8283f8e357a41e0168c33eb2418a\\",\\"productionreleasefilelength\\" 81108806,\\"betareleasefilelength\\" 81108806,\\"compatiblereleasefilelength\\" 74604516,\\"existingfwcontentid\\" \\"\\"},\\"raptor\\" {\\"firmwareupdatesource\\"\ null,\\"firmwareupdatesourcefilepath\\" \\"\\",\\"firmwareupdatesourceurl\\" \\"\\",\\"firmwareupdatestandardtargetfilename\\" \\"raptor update bsfw\\",\\"firmwareupdatedifferenttargetfilename\\" \\"raptor update different bsfw\\",\\"firmwareupdatenewertargetfilename\\" \\"raptor update newer bsfw\\",\\"firmwareupdatesavetargetfilename\\" \\"raptor update save bsfw\\",\\"firmwareupdateversion\\" \\"\\",\\"productionreleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/raptor 9 0 145 1 update bsfw\\",\\"betareleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/raptor 9 0 145 1 update bsfw\\",\\"compatiblereleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/raptor 9 0 22 3 update bsfw\\",\\"productionversion\\" \\"9 0 145 1\\",\\"betaversion\\" \\"9 0 145 1\\",\\"compatibleversion\\" \\"9 0 22 3\\",\\"productionversionnumber\\" 589969,\\"betaversionnumber\\" 589969,\\"compatibleversionnumber\\" 589846,\\"productionreleasesha1\\" \\"06ffdc99949dddf1645ad738ce4508597f0e8db0\\",\\"betareleasesha1\\" \\"06ffdc99949dddf1645ad738ce4508597f0e8db0\\",\\"compatiblereleasesha1\\" \\"245ef90811a7bcd2e1ca862b451c4d8abfaa5526\\",\\"productionreleasefilelength\\" 443631114,\\"betareleasefilelength\\" 443631114,\\"compatiblereleasefilelength\\" 343723720,\\"existingfwcontentid\\" \\"\\"},\\"cobra\\" {\\"firmwareupdatesource\\"\ null,\\"firmwareupdatesourcefilepath\\" \\"\\",\\"firmwareupdatesourceurl\\" \\"\\",\\"firmwareupdatestandardtargetfilename\\" \\"cobra update bsfw\\",\\"firmwareupdatedifferenttargetfilename\\" \\"cobra update different bsfw\\",\\"firmwareupdatenewertargetfilename\\" \\"cobra update newer bsfw\\",\\"firmwareupdatesavetargetfilename\\" \\"cobra update save bsfw\\",\\"firmwareupdateversion\\" \\"\\",\\"productionreleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/cobra 9 0 145 1 update bsfw\\",\\"betareleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/cobra 9 0 145 1 update bsfw\\",\\"compatiblereleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/cobra 9 0 75 update bsfw\\",\\"productionversion\\" \\"9 0 145 1\\",\\"betaversion\\" \\"9 0 145 1\\",\\"compatibleversion\\" \\"9 0 75\\",\\"productionversionnumber\\" 589969,\\"betaversionnumber\\" 589969,\\"compatibleversionnumber\\" 589899,\\"productionreleasesha1\\" \\"7d53871f30852a7851b5fa4a88f4640b4d18aa40\\",\\"betareleasesha1\\" \\"7d53871f30852a7851b5fa4a88f4640b4d18aa40\\",\\"compatiblereleasesha1\\" \\"a213680fa5d8fb9437bee43888c37b9fd932f62d\\",\\"productionreleasefilelength\\" 361576318,\\"betareleasefilelength\\" 361576318,\\"compatiblereleasefilelength\\" 259763696,\\"existingfwcontentid\\" \\"\\"}},\\"firmwareupdatetype\\" \\"standard\\",\\"setuptype\\" \\"bsn\\",\\"bsndeviceregistrationtokenentity\\" {\\"token\\" \\"qbziu4fdyevwz8r7edwk3isdrh72sdui6k7fel2cmna5pzbxbndn12qgwf78zggmmobodtp898ssdtcszy469zkxwboxxtarhtl71f3y6imfgxkyhnsxiwnczyfctxod\\",\\"scope\\" \\"cert\\",\\"validfrom\\" \\"2024 05 08t18 42 18 000z\\",\\"validto\\" \\"2026 05 08t18 42 18 000z\\"},\\"enableserialdebugging\\"\ false,\\"enablesystemlogdebugging\\"\ false,\\"remotedwsenabled\\"\ true,\\"dwsenabled\\"\ true,\\"dwspassword\\" \\"\\",\\"dwspasswordprevioussavedtimestamp\\" 1714573782270,\\"lwsenabled\\"\ true,\\"lwsconfig\\" \\"status\\",\\"lwsusername\\" \\"\\",\\"lwspassword\\" \\"\\",\\"lwsenableupdatenotifications\\"\ true,\\"bsncloudenabled\\"\ true,\\"devicename\\" \\"series 5\\",\\"devicedescription\\" \\"\\",\\"unitnamingmethod\\" \\"appendunitidtounitname\\",\\"timezone\\" \\"est\\",\\"bsngroupname\\" \\"default\\",\\"timebetweennetconnects\\" 300,\\"sfnwebfolderurl\\" \\"\\",\\"sfnusername\\" \\"\\",\\"sfnpassword\\" \\"\\",\\"sfnenablebasicauthentication\\"\ false,\\"playbackloggingenabled\\"\ false,\\"eventloggingenabled\\"\ false,\\"diagnosticloggingenabled\\"\ false,\\"stateloggingenabled\\"\ false,\\"variableloggingenabled\\"\ false,\\"uploadlogfilesatboot\\"\ false,\\"uploadlogfilesatspecifictime\\"\ false,\\"uploadlogfilestime\\" 0,\\"loghandlerurl\\" \\"\\",\\"enableremotesnapshot\\"\ false,\\"remotesnapshotinterval\\" 15,\\"remotesnapshotmaximages\\" 5,\\"remotesnapshotjpegqualitylevel\\" 50,\\"remotesnapshotscreenorientation\\" \\"landscape\\",\\"remotesnapshothandlerurl\\" \\"\\",\\"idlescreencolor\\" {\\"r\\" 112,\\"g\\" 40,\\"b\\" 150,\\"a\\" 1},\\"networkdiagnosticsenabled\\"\ false,\\"testethernetenabled\\"\ false,\\"testwirelessenabled\\"\ false,\\"testinternetenabled\\"\ false,\\"usecustomsplashscreen\\"\ false,\\"brightwallname\\" \\"\\",\\"brightwallscreennumber\\" \\"\\",\\"contentdownloadsrestricted\\"\ false,\\"contentdownloadrangestart\\" 0,\\"contentdownloadrangeend\\" 0,\\"usbupdatepassword\\" \\"\\",\\"inheritnetworkproperties\\"\ true,\\"internalcaartifacts\\" \[],\\"network\\" {\\"timeservers\\" \[\\"http //time brightsignnetwork com\\"],\\"hostname\\"\ null,\\"dns\\"\ null,\\"proxyserver\\"\ null,\\"proxybypass\\"\ null,\\"interfaces\\" \[{\\"id\\" \\"wired eth0\\",\\"name\\" \\"eth0\\",\\"type\\" \\"ethernet\\",\\"proto\\" \\"dhcpv4\\",\\"ip\\" \[],\\"gateway\\"\ null,\\"dns\\" \[],\\"ratelimitduringinitialdownloads\\" 0,\\"ratelimitinsidecontentdownloadwindow\\" 0,\\"ratelimitoutsidecontentdownloadwindow\\"\ null,\\"contentdownloadenabled\\"\ true,\\"textfeedsdownloadenabled\\"\ true,\\"mediafeedsdownloadenabled\\"\ true,\\"healthreportingenabled\\"\ true,\\"logsuploadenabled\\"\ true,\\"wpasettings\\" {\\"enablewpaenterpriseauthentication\\"\ false,\\"wpaenterprisevariant\\" \\"wpaenterpriseeaptls\\",\\"eapcertificatetype\\" \\"wpaeaptlspkcs\\",\\"eapcertificatefile\\"\ null,\\"eapcertificatepassphrase\\" \\"\\",\\"eappemorderkeyfile\\"\ null,\\"peapusername\\" \\"\\",\\"peappassphrase\\" \\"\\",\\"cacertificatefile\\"\ null}}]}}", "version" "2 0 0", "createdat" "2024 03 28t22 22 36 900z", "updatedat" "2024 05 08t18 42 18 692z", " v" 0 }, { " id" "63a4a2rf1d85beb6edd1245a", "username" "janedoe\@brightsign biz", "client" "bacon", "packagename" "testsetup", "setuptype" "lfn", "networkname" "janedoenetwork", "devicename" "mydevice", "devicedescription" "", "bsngroupname" "default", "setupjson" "{\\"uidevicesetuperrors\\" \[],\\"version\\" \\"2 0 0\\",\\"bdeploy\\" {\\"username\\" \\"janedoe\@brightsign biz\\",\\"networkname\\" \\"janedoenetwork\\",\\"client\\" \\"bacon\\",\\"packagename\\" \\"testsetup\\"},\\"firmwareupdatesbyfamily\\" {\\"impala\\" {\\"firmwareupdatesource\\"\ null,\\"firmwareupdatesourcefilepath\\" \\"\\",\\"firmwareupdatesourceurl\\" \\"\\",\\"firmwareupdatestandardtargetfilename\\" \\"impala update bsfw\\",\\"firmwareupdatedifferenttargetfilename\\" \\"impala update different bsfw\\",\\"firmwareupdatenewertargetfilename\\" \\"impala update newer bsfw\\",\\"firmwareupdatesavetargetfilename\\" \\"impala update save bsfw\\",\\"firmwareupdateversion\\" \\"\\",\\"productionreleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/impala 8 5 33 update bsfw\\",\\"betareleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/impala 8 5 33 update bsfw\\",\\"compatiblereleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/impala 8 0 119 update bsfw\\",\\"productionversion\\" \\"8 5 33\\",\\"betaversion\\" \\"8 5 33\\",\\"compatibleversion\\" \\"8 0 119\\",\\"productionversionnumber\\" 525601,\\"betaversionnumber\\" 525601,\\"compatibleversionnumber\\" 524407,\\"productionreleasesha1\\" \\"2880a46fe283ebceff9fcc29e3a3080518fcdc89\\",\\"betareleasesha1\\" \\"2880a46fe283ebceff9fcc29e3a3080518fcdc89\\",\\"compatiblereleasesha1\\" \\"65bdcc34479b2eec47a656aec260a849cce37ea0\\",\\"productionreleasefilelength\\" 148724028,\\"betareleasefilelength\\" 148724028,\\"compatiblereleasefilelength\\" 134766338,\\"existingfwcontentid\\" \\"\\"},\\"pantera\\" {\\"firmwareupdatesource\\"\ null,\\"firmwareupdatesourcefilepath\\" \\"\\",\\"firmwareupdatesourceurl\\" \\"\\",\\"firmwareupdatestandardtargetfilename\\" \\"pantera update bsfw\\",\\"firmwareupdatedifferenttargetfilename\\" \\"pantera update different bsfw\\",\\"firmwareupdatenewertargetfilename\\" \\"pantera update newer bsfw\\",\\"firmwareupdatesavetargetfilename\\" \\"pantera update save bsfw\\",\\"firmwareupdateversion\\" \\"\\",\\"productionreleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/pantera 8 5 33 update bsfw\\",\\"betareleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/pantera 8 5 33 update bsfw\\",\\"compatiblereleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/pantera 8 0 119 update bsfw\\",\\"productionversion\\" \\"8 5 33\\",\\"betaversion\\" \\"8 5 33\\",\\"compatibleversion\\" \\"8 0 119\\",\\"productionversionnumber\\" 525601,\\"betaversionnumber\\" 525601,\\"compatibleversionnumber\\" 524407,\\"productionreleasesha1\\" \\"d0504fb7e6a023a9ce742ce40f13066ef79b462a\\",\\"betareleasesha1\\" \\"d0504fb7e6a023a9ce742ce40f13066ef79b462a\\",\\"compatiblereleasesha1\\" \\"56b95119bd99440decbcf2cfda6ef68a775c9ebd\\",\\"productionreleasefilelength\\" 148263106,\\"betareleasefilelength\\" 148263106,\\"compatiblereleasefilelength\\" 134457680,\\"existingfwcontentid\\" \\"\\"},\\"tiger\\" {\\"firmwareupdatesource\\"\ null,\\"firmwareupdatesourcefilepath\\" \\"\\",\\"firmwareupdatesourceurl\\" \\"\\",\\"firmwareupdatestandardtargetfilename\\" \\"tiger update bsfw\\",\\"firmwareupdatedifferenttargetfilename\\" \\"tiger update different bsfw\\",\\"firmwareupdatenewertargetfilename\\" \\"tiger update newer bsfw\\",\\"firmwareupdatesavetargetfilename\\" \\"tiger update save bsfw\\",\\"firmwareupdateversion\\" \\"\\",\\"productionreleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/tiger 8 5 33 update bsfw\\",\\"betareleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/tiger 8 5 33 update bsfw\\",\\"compatiblereleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/tiger 8 0 119 update bsfw\\",\\"productionversion\\" \\"8 5 33\\",\\"betaversion\\" \\"8 5 33\\",\\"compatibleversion\\" \\"8 0 119\\",\\"productionversionnumber\\" 525601,\\"betaversionnumber\\" 525601,\\"compatibleversionnumber\\" 524407,\\"productionreleasesha1\\" \\"0f0485cd24b32529692378dc2e9c73cd33e9841c\\",\\"betareleasesha1\\" \\"0f0485cd24b32529692378dc2e9c73cd33e9841c\\",\\"compatiblereleasesha1\\" \\"c5c448183ed51acc6cf5681239bcc094c5273a9f\\",\\"productionreleasefilelength\\" 160765442,\\"betareleasefilelength\\" 160765442,\\"compatiblereleasefilelength\\" 144375550,\\"existingfwcontentid\\" \\"\\"},\\"pagani\\" {\\"firmwareupdatesource\\"\ null,\\"firmwareupdatesourcefilepath\\" \\"\\",\\"firmwareupdatesourceurl\\" \\"\\",\\"firmwareupdatestandardtargetfilename\\" \\"pagani update bsfw\\",\\"firmwareupdatedifferenttargetfilename\\" \\"pagani update different bsfw\\",\\"firmwareupdatenewertargetfilename\\" \\"pagani update newer bsfw\\",\\"firmwareupdatesavetargetfilename\\" \\"pagani update save bsfw\\",\\"firmwareupdateversion\\" \\"\\",\\"productionreleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/pagani 8 5 33 update bsfw\\",\\"betareleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/pagani 8 5 33 update bsfw\\",\\"compatiblereleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/pagani 8 0 119 update bsfw\\",\\"productionversion\\" \\"8 5 33\\",\\"betaversion\\" \\"8 5 33\\",\\"compatibleversion\\" \\"8 0 119\\",\\"productionversionnumber\\" 525601,\\"betaversionnumber\\" 525601,\\"compatibleversionnumber\\" 524407,\\"productionreleasesha1\\" \\"711caa8b86adb045767b340731c4c01d9aa229ac\\",\\"betareleasesha1\\" \\"711caa8b86adb045767b340731c4c01d9aa229ac\\",\\"compatiblereleasesha1\\" \\"4408683416b1265a0c69708b807ac3a5a303ec71\\",\\"productionreleasefilelength\\" 194572248,\\"betareleasefilelength\\" 194572248,\\"compatiblereleasefilelength\\" 164257912,\\"existingfwcontentid\\" \\"\\"},\\"malibu\\" {\\"firmwareupdatesource\\"\ null,\\"firmwareupdatesourcefilepath\\" \\"\\",\\"firmwareupdatesourceurl\\" \\"\\",\\"firmwareupdatestandardtargetfilename\\" \\"malibu update bsfw\\",\\"firmwareupdatedifferenttargetfilename\\" \\"malibu update different bsfw\\",\\"firmwareupdatenewertargetfilename\\" \\"malibu update newer bsfw\\",\\"firmwareupdatesavetargetfilename\\" \\"malibu update save bsfw\\",\\"firmwareupdateversion\\" \\"\\",\\"productionreleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/malibu 8 5 33 update bsfw\\",\\"betareleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/malibu 8 5 33 update bsfw\\",\\"compatiblereleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/malibu 8 0 119 update bsfw\\",\\"productionversion\\" \\"8 5 33\\",\\"betaversion\\" \\"8 5 33\\",\\"compatibleversion\\" \\"8 0 119\\",\\"productionversionnumber\\" 525601,\\"betaversionnumber\\" 525601,\\"compatibleversionnumber\\" 524407,\\"productionreleasesha1\\" \\"ecda439f6e39be950b3e6070b1ad254c0e10ef18\\",\\"betareleasesha1\\" \\"ecda439f6e39be950b3e6070b1ad254c0e10ef18\\",\\"compatiblereleasesha1\\" \\"a2fa8e63e86f78db2829e3b12803e5fdfb62b9f2\\",\\"productionreleasefilelength\\" 195873138,\\"betareleasefilelength\\" 195873138,\\"compatiblereleasefilelength\\" 174740222,\\"existingfwcontentid\\" \\"\\"},\\"sebring\\" {\\"firmwareupdatesource\\"\ null,\\"firmwareupdatesourcefilepath\\" \\"\\",\\"firmwareupdatesourceurl\\" \\"\\",\\"firmwareupdatestandardtargetfilename\\" \\"sebring update bsfw\\",\\"firmwareupdatedifferenttargetfilename\\" \\"sebring update different bsfw\\",\\"firmwareupdatenewertargetfilename\\" \\"sebring update newer bsfw\\",\\"firmwareupdatesavetargetfilename\\" \\"sebring update save bsfw\\",\\"firmwareupdateversion\\" \\"\\",\\"productionreleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/sebring 8 5 33 update bsfw\\",\\"betareleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/sebring 8 5 33 update bsfw\\",\\"compatiblereleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/sebring 8 2 17 3 update bsfw\\",\\"productionversion\\" \\"8 5 33\\",\\"betaversion\\" \\"8 5 33\\",\\"compatibleversion\\" \\"8 2 17 3\\",\\"productionversionnumber\\" 525601,\\"betaversionnumber\\" 525601,\\"compatibleversionnumber\\" 524817,\\"productionreleasesha1\\" \\"4baaaa6cc304c679617561cad89f656c821988c5\\",\\"betareleasesha1\\" \\"4baaaa6cc304c679617561cad89f656c821988c5\\",\\"compatiblereleasesha1\\" \\"399b5dd4203a8283f8e357a41e0168c33eb2418a\\",\\"productionreleasefilelength\\" 85372336,\\"betareleasefilelength\\" 85372336,\\"compatiblereleasefilelength\\" 74604516,\\"existingfwcontentid\\" \\"\\"},\\"raptor\\" {\\"firmwareupdatesource\\"\ null,\\"firmwareupdatesourcefilepath\\" \\"\\",\\"firmwareupdatesourceurl\\" \\"\\",\\"firmwareupdatestandardtargetfilename\\" \\"raptor update bsfw\\",\\"firmwareupdatedifferenttargetfilename\\" \\"raptor update different bsfw\\",\\"firmwareupdatenewertargetfilename\\" \\"raptor update newer bsfw\\",\\"firmwareupdatesavetargetfilename\\" \\"raptor update save bsfw\\",\\"firmwareupdateversion\\" \\"\\",\\"productionreleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/raptor 9 0 22 3 update bsfw\\",\\"betareleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/raptor 9 0 22 3 update bsfw\\",\\"compatiblereleaseurl\\" \\"https //bsncloud s3 amazonaws com/public/raptor 9 0 22 3 update bsfw\\",\\"productionversion\\" \\"9 0 22 3\\",\\"betaversion\\" \\"9 0 22 3\\",\\"compatibleversion\\" \\"9 0 22 3\\",\\"productionversionnumber\\" 589846,\\"betaversionnumber\\" 589846,\\"compatibleversionnumber\\" 589846,\\"productionreleasesha1\\" \\"245ef90811a7bcd2e1ca862b451c4d8abfaa5526\\",\\"betareleasesha1\\" \\"245ef90811a7bcd2e1ca862b451c4d8abfaa5526\\",\\"compatiblereleasesha1\\" \\"245ef90811a7bcd2e1ca862b451c4d8abfaa5526\\",\\"productionreleasefilelength\\" 343723720,\\"betareleasefilelength\\" 343723720,\\"compatiblereleasefilelength\\" 343723720,\\"existingfwcontentid\\" \\"\\"}},\\"firmwareupdatetype\\" \\"standard\\",\\"setuptype\\" \\"lfn\\",\\"bsndeviceregistrationtokenentity\\" {\\"token\\" \\"wxp32uug5gtvtfajfyyo1e5ipik827fe0hp0excrgfalknzzu7zptwipcpm6pbfnpyyimnmpkmsaqgrqftrfiygiafw8mhvx4psdgwgiuqxlzyagzcv5nb9ers1gyt5x\\",\\"scope\\" \\"cert\\",\\"validfrom\\" \\"2022 12 22t18 33 19 000z\\",\\"validto\\" \\"2024 12 21t18 33 19 000z\\"},\\"enableserialdebugging\\"\ false,\\"enablesystemlogdebugging\\"\ false,\\"remotedwsenabled\\"\ true,\\"dwsenabled\\"\ false,\\"dwspassword\\" \\"\\",\\"dwspasswordprevioussavedtimestamp\\" 1670283952000,\\"lwsenabled\\"\ true,\\"lwsconfig\\" \\"status\\",\\"lwsusername\\" \\"\\",\\"lwspassword\\" \\"\\",\\"lwsenableupdatenotifications\\"\ true,\\"bsncloudenabled\\"\ true,\\"devicename\\" \\"mydevice\\",\\"devicedescription\\" \\"fajdk;dlfjk\\",\\"unitnamingmethod\\" \\"appendunitidtounitname\\",\\"timezone\\" \\"pst\\",\\"bsngroupname\\" \\"default\\",\\"timebetweennetconnects\\" 300,\\"timebetweenheartbeats\\" 900,\\"sfnwebfolderurl\\" \\"\\",\\"sfnusername\\" \\"\\",\\"sfnpassword\\" \\"\\",\\"sfnenablebasicauthentication\\"\ false,\\"playbackloggingenabled\\"\ false,\\"eventloggingenabled\\"\ false,\\"diagnosticloggingenabled\\"\ false,\\"stateloggingenabled\\"\ false,\\"variableloggingenabled\\"\ false,\\"uploadlogfilesatboot\\"\ false,\\"uploadlogfilesatspecifictime\\"\ false,\\"uploadlogfilestime\\" 0,\\"loghandlerurl\\" \\"\\",\\"enableremotesnapshot\\"\ false,\\"remotesnapshotinterval\\" 15,\\"remotesnapshotmaximages\\" 5,\\"remotesnapshotjpegqualitylevel\\" 50,\\"remotesnapshotscreenorientation\\" \\"landscape\\",\\"remotesnapshothandlerurl\\" \\"\\",\\"idlescreencolor\\" {\\"r\\" 0,\\"g\\" 0,\\"b\\" 0,\\"a\\" 1},\\"networkdiagnosticsenabled\\"\ false,\\"testethernetenabled\\"\ false,\\"testwirelessenabled\\"\ false,\\"testinternetenabled\\"\ false,\\"usecustomsplashscreen\\"\ false,\\"brightwallname\\" \\"\\",\\"brightwallscreennumber\\" \\"\\",\\"contentdownloadsrestricted\\"\ false,\\"contentdownloadrangestart\\" 0,\\"contentdownloadrangeend\\" 0,\\"heartbeatsrestricted\\"\ false,\\"heartbeatsrangestart\\" 0,\\"heartbeatsrangeend\\" 0,\\"usbupdatepassword\\" \\"\\",\\"inheritnetworkproperties\\"\ true,\\"internalcaartifacts\\" \[],\\"network\\" {\\"timeservers\\" \[\\"http //time brightsignnetwork com\\"],\\"hostname\\"\ null,\\"dns\\"\ null,\\"proxyserver\\"\ null,\\"proxybypass\\"\ null,\\"interfaces\\" \[{\\"id\\" \\"wired eth0\\",\\"name\\" \\"eth0\\",\\"type\\" \\"ethernet\\",\\"proto\\" \\"dhcpv4\\",\\"ip\\" \[],\\"gateway\\"\ null,\\"dns\\" \[],\\"ratelimitduringinitialdownloads\\" 0,\\"ratelimitinsidecontentdownloadwindow\\" 0,\\"ratelimitoutsidecontentdownloadwindow\\"\ null,\\"contentdownloadenabled\\"\ true,\\"textfeedsdownloadenabled\\"\ true,\\"mediafeedsdownloadenabled\\"\ true,\\"healthreportingenabled\\"\ true,\\"logsuploadenabled\\"\ true,\\"wpasettings\\" {\\"enablewpaenterpriseauthentication\\"\ false,\\"wpaenterprisevariant\\" \\"wpaenterpriseeaptls\\",\\"eapcertificatetype\\" \\"wpaeaptlspkcs\\",\\"eapcertificatefile\\"\ null,\\"eapcertificatepassphrase\\" \\"\\",\\"eappemorderkeyfile\\"\ null,\\"peapusername\\" \\"\\",\\"peappassphrase\\" \\"\\",\\"cacertificatefile\\"\ null}}]},\\" id\\" \\"63a4a2ef1d85aeb5edee245a\\"}", "version" "2 0 0", "createdat" "2022 12 22t18 33 19 899z", "updatedat" "2022 12 22t18 33 19 913z", " v" 0 } ] } failure response 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 5xx 5xx any 500 code is an internal server error get /setup/ id/ retrieves a player setup from the b deploy server url parameters id string string the unique identifier of the player setup to retrieve if this parameter is not included in the url, the get request will return all player setups associated with the username networkname string string required required the unique identifier of the network request example id is set to 1234567890 networkname is set to janedoenetwork get /rest setup/v2/setup/? id=1234567890\&networkname=janedoenetwork http/1 1 host provision bsn cloud content type application/json authorization {{bearer token}} success response body 200 200 contains a single player setup failure response 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 5xx 5xx any 500 code is an internal server error post adds a new player setup to the b deploy server request body the following list includes only properties that are required to create a player setup (except for url ) version string string required required the b deploy cloud version this value should currently be "2 0 0" bdeploy bdeploy\[ ] bdeploy\[ ] required required a b deploy entity (v2) docid 4bwedveqfcxy47vvpofle setuptype string string required required the player setup type "bsn", "lfn", "sfn", "standalone", or “partnerapplication” bsndeviceregistrationtokenentity tokenentity\[ ] tokenentity\[ ] required required a registration token that is used to register the player with a bsn cloud network (see token entity (v2) docid\ zdekpspip0nbht48yj19l ) see main api version 2022/06 docid 0qhibo6ras8zwyjybeh0r for information about how to get a user access token bsngroupname string string required required the name of the bsn cloud group to which provisioned players will be assigned this value defaults to the "default" group if undefined remotedwsenabled bool bool required required a flag indicating whether the remote dws is enabled or disabled on the player url string string optional optional an optional value of the partner application url specified for a player to use when finding the application to download request example post /rest setup/v2/setup http/1 1 host provision bsn cloud content type application/json authorization {{bearer token}} content length 10427 this is the example request body expand { "version" "2 0 0", "bdeploy" { "username" "janedoe\@gmail com", "networkname" "janedoenetwork", "packagename" "fullsetup2" }, "setuptype" "bsn", "bsndeviceregistrationtokenentity" { "token" {{token}}, "scope" "add device setup", "validfrom" "2018 09 28t19 47 09 577z", "validto" "2018 09 28t19 47 09 577z" }, "firmwareupdatetype" "standard", "enableserialdebugging" true, "enablesystemlogdebugging" true, "dwsenabled" true, "dwspassword" "", "lwsenabled" true, "lwsconfig" "status", "lwsusername" "", "lwspassword" "", "lwsenableupdatenotifications" true, "devicename" "", "devicedescription" "", "unitnamingmethod" "appendunitidtounitname", "timezone" "pst", "bsngroupname" "default", "timebetweennetconnects" 300, "timebetweenheartbeats" 900, "sfnwebfolderurl" "", "sfnusername" "", "sfnpassword" "", "sfnenablebasicauthentication" false, "playbackloggingenabled" false, "eventloggingenabled" false, "diagnosticloggingenabled" false, "stateloggingenabled" false, "variableloggingenabled" false, "uploadlogfilesatboot" false, "uploadlogfilesatspecifictime" false, "uploadlogfilestime" 0, "loghandlerurl" "", "enableremotesnapshot" false, "remotesnapshotinterval" 69, "remotesnapshotmaximages" 69, "remotesnapshotjpegqualitylevel" 100, "remotesnapshotscreenorientation" "landscape", "remotesnapshothandlerurl" "", "usewireless" false, "ssid" "", "passphrase" "", "timeserver" "http //time brightsignnetwork com", "idlescreencolor" { "r" 0, "g" 0, "b" 0, "a" 1 }, "contentdatatypeenabledwired" true, "textfeedsdatatypeenabledwired" true, "healthdatatypeenabledwired" true, "mediafeedsdatatypeenabledwired" true, "loguploadsxfersenabledwired" true, "contentdatatypeenabledwireless" true, "textfeedsdatatypeenabledwireless" true, "healthdatatypeenabledwireless" true, "mediafeedsdatatypeenabledwireless" true, "loguploadsxfersenabledwireless" true, "ratelimitmodeoutsidewindow" "default", "ratelimitrateoutsidewindow" 0, "ratelimitmodeinwindow" "unlimited", "ratelimitrateinwindow" 0, "ratelimitmodeinitialdownloads" "unlimited", "ratelimitrateinitialdownloads" 0, "networkconnectionpriority" "wired", "networkdiagnosticsenabled" false, "testethernetenabled" false, "testwirelessenabled" false, "testinternetenabled" false, "usecustomsplashscreen" false, "brightwallname" "", "brightwallscreennumber" "", "specifyhostname" false, "hostname" "", "useproxy" false, "proxyaddress" "", "proxyport" 0, "networkhosts" \[], "contentdownloadsrestricted" false, "contentdownloadrangestart" 0, "contentdownloadrangeend" 0, "heartbeatsrestricted" false, "heartbeatsrangestart" 0, "heartbeatsrangeend" 0, "usedhcp" true, "staticipaddress" "", "subnetmask" "", "gateway" "", "dns1" "", "dns2" "", "dns3" "", "usedhcp 2" true, "staticipaddress 2" "", "subnetmask 2" "", "gateway 2" "", "dns1 2" "", "dns2 2" "", "dns3 2" "", "ratelimitmodeoutsidewindow 2" "default", "ratelimitrateoutsidewindow 2" 0, "ratelimitmodeinwindow 2" "unlimited", "ratelimitrateinwindow 2" 0, "ratelimitmodeinitialdownloads 2" "unlimited", "ratelimitrateinitialdownloads 2" 0, "usbupdatepassword" "", "remotedwsenabled" true } success response 200 200 the unique identifier of the player setup object failure response 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 415 415 the server cannot accept the data representation that you sent (as specified in the header) 5xx 5xx any 500 code is an internal server error put updates an existing player setup on the b deploy server you must include the id property in the player setup object to specify the player setup to update request body id string string the unique identifier of the player setup object to modify version string string the b deploy cloud version this value should currently be "2 0 0" setuptype string string the player setup type this value is currently always "bsn" bsngroupname string string the name of the bsn cloud group to which provisioned players will be assigned this value defaults to the "default" group if undefined url string string optional optional a value of the partner application url specified for a player to use when finding the application to download remotedwsenabled bool bool a flag indicating whether the remote dws is enabled or disabled on the player bdeploy bdeploy\[] bdeploy\[] a b deploy entity (v2) docid 4bwedveqfcxy47vvpofle bsndeviceregistrationtokenentity tokenentity\[] tokenentity\[] a token entity (v2) docid\ zdekpspip0nbht48yj19l success response 200 200 the existing player setup has been updated failure response 400 400 either the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 415 415 the server cannot accept the data representation that you sent (as specified in the header) 5xx 5xx any 500 code is an internal server error delete deletes a player setup from the b deploy server url parameters id string string the unique identifier of the player setup to delete request example id is set to 1234567890 delete /rest setup/v2/setup/? id=1234567890 http/1 1 host provision bsn cloud content type application/json authorization {{bearer token}} success response 200 200 the specified player setup has been removed failure response 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 5xx 5xx any 500 code is an internal server error