...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Base URL for these endpoints: https://ws.bsn.cloud/rest/v1/
_________________________________________________________________________
GET /registry/
Returns the player registry dump
Request Example
| Code Block |
|---|
GET /rest/v1/registry/?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json |
Response Body
successbool: If the operation is successfulvalueobject: The keys are the names of the registry sections. These are some examples:brightscriptobject: The BrightScript key-value pairsnetworkingobject: The networking key-value pairs
Response Example
| Expand | |||||
|---|---|---|---|---|---|
| |||||
|
...
|
...
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
GET /registry/:section/:key/
Returns a particular registry section or key value
Segment
...
sectionstring: The name of the registry section (for example, "html" or "networking")keystring: The name of the registry key
Request Example
This example gets the telnet port number from the networking section:
| Code Block |
|---|
GET /rest/v1/registry/networking/telnet?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}} |
Response Example
| Code Block | ||
|---|---|---|
| ||
{
"route": "/v1/registry/brightscript/g",
"method": "GET",
"data": {
"result": {
"success": true,
"section": "brightscript",
"key": "g",
"value": ""
}
}
} |
PUT /registry/:section/:key/
Sets a value in the specified section of the registry. Do a GET first to see which keys are available.
| Note |
|---|
Applications rely on the values they have set in the registry. Please be mindful of what you type to avoid putting the player in an unstable state. |
Segment
...
sectionstring: The name of the registry section (for example, "html" or "networking")keystring: The name of the registry key
Request Example
This example sets the telnet port number in the networking section of registry:
| Code Block |
|---|
PUT /rest/v1/registry/networking/telnet?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}}
Content-Type: application/json
Content-Length: 47 |
...
This is the example request body:
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"value": 23
}
} |
...
DELETE /registry/:section/:key/
...
Response Example
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"result": {
"success": true,
"section": "networking",
"key": "telnet",
"value": "23"
}
},
"route": "/v1/registry/networking/telnet",
"method": "PUT"
} |
DELETE /registry/:section/:key/
Deletes a key-value pair from the specified registry section, or the whole section.
| Note |
|---|
Applications rely on the values they have set in the registry. Please be mindful of what you type to avoid putting the player in an unstable state. |
Segment
...
sectionstring: The name of the registry section (for example, "html" or "networking")keystring: The name
...
Request Example
This example deletes the telnet key from the networking section of registry:
...
of the registry key
Request Example
This example deletes the telnet key from the networking section of registry:
| Code Block |
|---|
DELETE /rest/v1/registry/networking/telnet?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}} |
Response Example
| Code Block | ||
|---|---|---|
| ||
{ "route": "/v1/registry/networking/telnet |
...
Response Example
...
| language | json |
|---|
...
", "method": "DELETE", "data": { "result": { "success": true, " |
...
section": " |
...
networking |
...
", " |
...
key": " |
...
telnet" |
...
|
...
|
...
} |
...
}
} |
PUT /registry/flush/
Flush the registry immediately to disk. This is available as of BOS 9.0.110 and 8.5.47. If you are on an earlier OS, you can reboot the player to flush the registry.
Request Example
| Code Block |
|---|
PUT /rest/v1/registry/flush?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}} |
Response Example
| Code Block | ||
|---|---|---|
| ||
{ |
...
" |
...
route": " |
...
/v1/registry/flush", |
...
" |
...
method": " |
...
PUT", |
...
PUT /registry/flush/
Flush the registry immediately to disk. This is available as of BOS 9.0.110 and 8.5.47. If you are on an earlier OS, you can reboot the player to flush the registry.
Request Example
...
"data": { "result": { "success": true } } } |
GET /registry/recovery_url/
Retrieves the recovery URL stored in the player registry
Request Example
| Code Block |
|---|
GET /rest/v1/registry/recovery_url/?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json |
Response Body
successbool: A flag indicating whether the request was successfully readvaluestring: The recovery URL
Response Example
| Code Block | ||
|---|---|---|
| ||
{
"route": "/v1/registry/recovery_url",
"method": "GET",
"data": {
"result": {
"success": true,
"value": "https://handlers.bsn.cloud//recovery/recovery.ashx"
}
}
} |
PUT /registry/recovery_url/
Writes a new recovery URL to the player registry
Request Body
urlstring: The new recovery URL
Request Example
| Code Block |
|---|
PUT /rest/v1/registry/recovery_url/?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Content-Type: application/json
Content-Length: 61 |
This is the example request body:
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"url": "https://test.com"
}
} |
Response Body
successbool: A flag indicating whether the write was successful
Response Example
| Code Block | ||
|---|---|---|
| ||
{
"data": {
"result": {
"success": true
}
},
"route": "/v1/registry/recovery_url",
"method": "PUT"
} |