You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 3 Next »
Returns the entire registry dump. The hidden registry sections are not returned in this response.
The example request parameters and headers are set as follows:
GET /api/v1/registry/ HTTP/1.1 Host: {{player_ip_address}} Accept: application/json
success bool: If the operation is successful
success
value object: The keys are the names of the registry sections. These are some examples:
value
brightscript string: The BrightScript key-value pairs
brightscript
networking string: The networking key-value pairs
networking
Returns a particular key value for a specified section and key.
section string: The name of the registry section
section
key string: The name of the registry key
key
section is set to html
html
key is set to use-brightsign-media-player
use-brightsign-media-player
GET /api/v1/registry/html/use-brightsign-media-player/ HTTP/1.1 Host: {{player_ip_address}} Accept: application/json, application/vnd.bsn.error+json
Creates registry values. 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.
section string: The name of the registry section (for example, "html" or "networking")
PUT /api/v1/registry/html/use-brightsign-media-player/ HTTP/1.1 Host: {{local_ip_address}} Accept: application/json Content-Type: application/json Content-Length: 33
This is the example request body:
{ "value": "0" }
Remove the specified registry values.
DELETE /api/v1/registry/html/use-brightsign-media-player/ HTTP/1.1 Host: {{player_ip_address}} Accept: application/json
Deletes an entire registry section
section is set to test_section
test_section
DELETE /api/v1/registry/test_section/ HTTP/1.1 Host: {{player_ip_address}} Accept: application/json
Retrieves the recovery URL stored in the player registry
recovery_url is the recovery URL in the player registry
recovery_url
GET /api/v1/registry/recovery_url/ HTTP/1.1 Host: {{player_ip_address}} Accept: application/json
success bool: A flag indicating whether the request was successfully read
value string: The recovery URL
Updates the recovery URL in the player’s registry.
url string: The value of the recovery URL
url
url is set to www.google.com
www.google.com
PUT /api/v1/registry/recovery_url/ HTTP/1.1 Host: {{player_ip_address}} Accept: application/json Content-Type: application/json Content-Length: 37
{ "url": "www.google.com" }