B-Deploy Setup Endpoints (v3)

these endpoints allow users to automatically provision brightsign players over the internet this endpoint handles everything regarding individual players add your serial number to brightsign’s cloud storage with an associated player name, provisioning package name, and the url where the provisioning package is hosted the url is optional it can be left blank if using a setup package version 3 0 of these apis contains additional support for multiple network interfaces through the network docid\ q84emt6m9ggaj8smutpq7 object base url for these endpoints https //provision bsn cloud/rest setup/v3/setup/ get / returns a list of setup records in the exact format they are stored in the b deploy database the main setup values are stored in each array object in the “setupjson” parameter if you want to get information about a specific b deploy setup, see get / id/ docid\ aqq49ls5eyge5ou gewpu query string parameter networkname \<font color="#704ae0">string\</font> \<font color="#01a0af">required \</font> the user defined name of the bsn cloud network username \<font color="#704ae0">string\</font> \<font color="#01a0af">optional \</font> the name of the user who created the setup package packagename \<font color="#704ae0">string\</font> \<font color="#01a0af">optional \</font> the user defined name of the setup package request example username is set to janedoe\@brightsign biz networkname is set to janedoenetwork packagename is set to my setup package get /rest setup/v3/setup/?username=janedoe%40brightsign biz\&networkname=janedoenetwork\&packagename=my%20setup%20package http/1 1 host provision bsn cloud authorization {{bearer token}} accept application/json success response body \<font color="#089a4d">200\</font> returns a list of setup package info entity (v3) docid\ q92ihzrqrweln yhgxk e success response example { "error" null, "result" \[ { " id" "1a2b3c4d5e6f7a8b9c0d1e2f", "username" "janedoe\@brightsign biz", "client" "bacon", "packagename" "my setup package", "setuptype" "bsn", "networkname" "janedoenetwork", "devicename" "my player", "devicedescription" "", "bsngroupname" "default", "setupjson" "{\\"version\\" \\"3 0 0\\",\\" id\\" \\"1a2b3c4d5e6f7a8b9c0d1e2f\\",\\"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" "3 0 0", "createdat" "2025 03 28t22 22 36 900z", "updatedat" "2025 05 08t18 42 18 692z", " v" 0 } ] } failure response \<font color="#9a0808">400\</font> the request is malformed and therefore invalid (for example, networkname is not specified) \<font color="#9a0808">401\</font> the access token is invalid or not specified \<font color="#9a0808">403\</font> the supplied access token, though valid, doesn't provide access to this method the access token used to call this /v3/setup api must belong to the same network \<font color="#9a0808">5xx\</font> any 500 code is an internal server error get / id/ retrieves one setup package having the specified id from the b deploy server route parameter id \<font color="#704ae0">string\</font> \<font color="#01a0af">required \</font> the primary identifier of the setup package you want to retrieve this "id" is returned in the response to /rest setup/v3/setup/post example request get /rest setup/v3/setup/1a2b3c4d5e6f7a8b9c0d1e2f/ http/1 1 host provision bsn cloud authorization {{bearer token}} accept application/json success response body \<font color="#089a4d">200\</font> returns an empty array of device setup errors and the device setup entity (v3) docid\ rhtiqljdtc jzorvpnv8 failure response \<font color="#9a0808">400\</font> the request is malformed and therefore invalid \<font color="#9a0808">401\</font> the access token is invalid or not specified \<font color="#9a0808">403\</font> the supplied access token, though valid, doesn't provide access to this method the access token used to call this /v3/setup api must belong to the same network \<font color="#9a0808">5xx\</font> any 500 code is an internal server error post / creates a setup package on the b deploy server request body the device setup entity (v3) docid\ rhtiqljdtc jzorvpnv8 example request post /rest setup/v3/setup http/1 1 host provision bsn cloud authorization {{bearer token}} content type application/json content length 10427 accept application/json this is the example request body expand { "version" "3 0 0", "bdeploy" { "username" "janedoe\@gmail com", "networkname" "janedoenetwork", "packagename" "fullsetup2" }, "setuptype" "bsn", "bsndeviceregistrationtokenentity" { "token" {{token}}, "scope" "certs", "validfrom" "2024 09 28t19 47 09 577z", "validto" "2026 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 body \<font color="#089a4d">201\</font> the id of the newly created setup package response { "error" null, "result" "1a2b3c4d5e6f7a8b9c0d1e2f" } failure response \<font color="#9a0808">400\</font> the request is malformed and therefore invalid \<font color="#9a0808">401\</font> the access token is invalid or not specified \<font color="#9a0808">403\</font> the supplied access token, though valid, doesn't provide access to this method \<font color="#9a0808">415\</font> the server cannot accept the data representation that you sent (as specified in the header) \<font color="#9a0808">5xx\</font> any 500 code is an internal server error put / modifies an existing setup package on the b deploy server request body devicesetup \<font color="#704ae0">object \</font> a device setup entity (v3) docid\ rhtiqljdtc jzorvpnv8 example request put /rest setup/v3/setup http/1 1 host provision bsn cloud authorization {{bearer token}} content type application/json content length 5058 accept application/json this is the example request body expand { "version" "3 0 0", "bdeploy" { "username" "janedoe\@gmail com", "networkname" "janedoenetwork", "packagename" "fullsetup2" }, "setuptype" "bsn", "bsndeviceregistrationtokenentity" { "token" {{token}}, "scope" "certs", "validfrom" "2024 09 28t19 47 09 577z", "validto" "2026 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 \<font color="#089a4d">200\</font> the existing setup package has been successfully modified failure response \<font color="#9a0808">400\</font> either the request or request body is malformed and therefore invalid \<font color="#9a0808">401\</font> the access token is invalid or not specified \<font color="#9a0808">403\</font> the supplied access token, though valid, doesn't provide access to this method \<font color="#9a0808">415\</font> the server cannot accept the data representation that you sent (as specified in the header) \<font color="#9a0808">5xx\</font> any 500 code is an internal server error delete / id/ deletes an existing setup package having the specified id from the b deploy server query string parameter id \<font color="#704ae0">string\</font> \<font color="#01a0af">required \</font> the unique identifier of the device setup to delete request example id is set to 1a2b3c4d5e6f7a8b9c0d1e2f delete /rest setup/v3/setup/? id=1a2b3c4d5e6f7a8b9c0d1e2f http/1 1 host provision bsn cloud authorization {{bearer token}} content type application/json accept application/json success response \<font color="#089a4d">200\</font> the specified setup package has been successfully deleted failure response \<font color="#9a0808">400\</font> the request is malformed and therefore invalid \<font color="#9a0808">401\</font> the access token is invalid or not specified \<font color="#9a0808">403\</font> the supplied access token, though valid, doesn't provide access to this method \<font color="#9a0808">5xx\</font> any 500 code is an internal server error