B-Deploy Setup Endpoints (v3)

8 min

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 NetworkNetwork 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/

Query String Parameter

NetworkName string required: The user-defined name of the BSN.Cloud network

username string optional: The name of the user who created the Setup package

packageName string optional: The user-defined name of the Setup package.

Request Example

username is set to [email protected]

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

200: Returns a list of Setup Package Info Entity (v3)

Success Response Example

{
  "error": null,
  "result": [
    {
      "_id": "1a2b3c4d5e6f7a8b9c0d1e2f",
      "username": "[email protected]",
      "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\":\"[email protected]\",\"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

400: The request is malformed and therefore invalid (for example, NetworkName is not specified)

401: The access token is invalid or not specified

403: 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.

5XX: 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 string required: 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

200: Returns an empty array of device setup errors and the Device Setup Entity (v3).

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. The access token used to call this /v3/setup API must belong to the same network.

5XX: 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)Device Setup Entity (v3)

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:

{
  "version": "3.0.0",
  "bDeploy": {
    "username": "[email protected]",
    "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

201: The ID of the newly created Setup package

Response

{
  "error": null,
  "result": "1a2b3c4d5e6f7a8b9c0d1e2f"
}

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 /

Modifies an existing Setup package on the B-Deploy server

Request Body

DeviceSetup object: A Device Setup Entity (v3)Device Setup Entity (v3)

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:

{
  "version": "3.0.0",
  "bDeploy": {
    "username": "[email protected]",
    "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

200: The existing Setup package has been successfully modified

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 /:_id/

Deletes an existing Setup package having the specified ID from the B-Deploy server

Query String Parameter

_id string required: 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

200: The specified Setup package has been successfully deleted

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