rDWS Registry Endpoints

Base URL for these endpoints: https://ws.bsn.cloud/rest/v1/

_________________________________________________________________________

GET /registry/

Returns the player registry dump

Request Example

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

success bool: If the operation is successful
value object: The keys are the names of the registry sections. These are some examples:
- brightscript object: The BrightScript key-value pairs
- networking object: The networking key-value pairs

GET /registry/:section/:key/

Returns a particular registry section or key value

Segment Values

section string: The name of the registry section (for example, "html" or "networking")
key string: The name of the registry key

Request Example

This example gets the telnet port number from the networking section:

GET /rest/v1/registry/networking/telnet?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1
Host: ws.bsn.cloud
Authorization: Bearer {{UserAccessToken}}

PUT /registry/:section/:key/

Sets a value in the specified section of the registry. Do a GET first to see which keys are available.

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 Values

section string: The name of the registry section (for example, "html" or "networking")
key string: The name of the registry key

Request Example

This example sets the telnet port number in the networking section of registry:

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

Request Body

DELETE /registry/:section/:key/

Deletes a key-value pair from the specified registry section, or the whole section.

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 Values

section string: The name of the registry section (for example, "html" or "networking")
key string: The name of the registry key

Request Example

This example deletes the telnet key from the networking section of registry:

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

GET /registry/recovery_url/

Retrieves the recovery URL stored in the player registry

Request Example

Response Body

success bool: A flag indicating whether the request was successfully read
value string: The recovery URL

PUT /registry/recovery_url/

Writes a new recovery URL to the player registry

Request Body

url string: The new recovery URL

Request Example

This is the example request body:

Response Body

success bool: A flag indicating whether the write was successful