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
___________________________________________________
Request Example
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 : Contains:
Success Response Example
Expand
{
"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 : The request is malformed and therefore invalid
401 : The access token is invalid or not specified
403 : The supplied access token, though valid, doesn't provide access to this method.
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 : 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 required : The unique identifier of the network
___________________________________________________
Request Example
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 : Contains a single player setup
Failure Response
400 : The request is malformed and therefore invalid
401 : The access token is invalid or not specified
403 : The supplied access token, though valid, doesn't provide access to this method.
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 required : The B-Deploy Cloud version. This value should currently be "2.0.0".
bDeploy bDeploy[ ] required : A B-Deploy Entity (v2)
setupType string required : The player setup type: "bsn", "lfn", "sfn", "standalone", or “partnerApplication”
bsnDeviceRegistrationTokenEntity tokenEntity[ ] required : A registration token that is used to register the player with a BSN.cloud network (see Token Entity (v2) this page for information about how to get a user access token.
bsnGroupName string 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 required : A flag indicating whether the Remote DWS is enabled or disabled on the player
url string optional : An optional value of the Partner Application URL specified for a player to use when finding the application to download.
___________________________________________________
Request Example
This is the example request body:
___________________________________________________
Success Response
200 : The unique identifier of the player setup object
Failure Response
400 : The request is malformed and therefore invalid
401 : The access token is invalid or not specified
403 : The supplied access token, though valid, doesn't provide access to this method
415 : The server cannot accept the data representation that you sent (as specified in the header)
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 : The unique identifier of the player setup object to modify
version string : The B-Deploy Cloud version. This value should currently be "2.0.0".
setupType string : The player setup type. This value is currently always "bsn".
bsnGroupName 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 : An optional value of the Partner Application URL specified for a player to use when finding the application to download.
remoteDwsEnabled bool : A flag indicating whether the Remote DWS is enabled or disabled on the player
bDeploy bDeploy[ ] : A B-Deploy Entity (v2)
bsnDeviceRegistrationTokenEntity tokenEntity{ } : A Token Entity (v2)
___________________________________________________
Success Response
200 : The existing player setup has been updated
Failure Response
400 : Either the request or request body is malformed and therefore invalid
401 : The access token is invalid or not specified
403 : The supplied access token, though valid, doesn't provide access to this method
415 : The server cannot accept the data representation that you sent (as specified in the header)
5XX : Any 500 code is an internal server error
DELETE Deletes a player setup from the B-Deploy server.
URL Parameters
___________________________________________________
Request Example
___________________________________________________
Success Response
200 : The specified player setup has been removed
Failure Response
400 : The request is malformed and therefore invalid
401 : The access token is invalid or not specified
403 : The supplied access token, though valid, doesn't provide access to this method
5XX : Any 500 code is an internal server error