...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
GET /v1/registry/
Returns the entire registry dump. The hidden registry sections are not returned in this response.
Request Example
The example request parameters and headers are set as follows:
Code Block |
---|
GET /api/v1/registry/ HTTP/1.1 Host: {{playerIP}} Authorization: {{ |
...
DigestAuth}} Accept: application/json |
Response Body
success
bool: If the operation is successfulvalue
object: The keys are the names of the registry sections. These are some examples:brightscript
string: The BrightScript key-value pairsnetworking
string: The networking key-value pairs
Response Example
Expand | |||||
---|---|---|---|---|---|
| |||||
|
GET /v1/registry/:section/:key/
Returns a particular key value for a specified section and key.
Segment Values
section
string: The name of the registry sectionkey
string: The name of the registry key
Request Example
The example request parameters and headers are set as follows:
section
is set tohtml
key
is set touse-brightsign-media-player
Code Block |
---|
GET /api/v1/registry/html/use-brightsign-media-player/ HTTP/1.1 Host: {{playerIP}} Authorization: {{ |
...
DigestAuth}} Accept: application/json |
Response Example
Code Block | ||
---|---|---|
| ||
{ "data": { "result": { "success": true, "section": "brightscript", "key": "g", |
...
"value": ""
}
}
} |
PUT /v1/registry/:section/:key/
Creates registry values. 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 registry keys you |
...
update 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
The example request parameters and headers are set as follows:
section
is set tohtml
key
is set touse-brightsign-media-player
Code Block |
---|
PUT /api/v1/registry/html/use-brightsign-media-player/ HTTP/1.1
Host: {{ |
...
playerIP}} |
...
Authorization: |
...
{{DigestAuth}} Content-Type: application/json Content-Length: 33 |
This is the example request body:
Code Block | ||
---|---|---|
| ||
{ "value": "0" } |
Response Example
Code Block | ||
---|---|---|
| ||
{ "data": { "result": { "success": true, "section": "html", "key": "use-brightsign-media-player", "value": "23" } } } |
DELETE /v1/registry/:section/:key/
Remove the specified registry values.
Note |
---|
Applications rely on the values they have set in the registry. Please be mindful of what registry keys you |
...
delete 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
...
value
Request Example
The example request parameters and headers are set as follows:
section
is set tohtml
key
is set touse-brightsign-media-player
Code Block |
---|
DELETE /api/v1/registry/html/use-brightsign-media-player/ HTTP/1.1 Host: {{playerIP}} Authorization: {{ |
...
DigestAuth}} Accept: application/json |
Response Body
success
bool: A flag indicating whether the registry key was deletedsection
string: This flag is set to the registry sectionkey
string: This flag is set to the registry key
Response Example
Code Block | ||
---|---|---|
| ||
{
"data": {
"result": {
"success": true,
"section": "html",
"key": "use-brightsign-media-player"
}
}
} |
DELETE /v1/registry/:section/
Deletes an entire registry section
Segment
section
string: The name of the registry section (for example, "html" or "networking")
Request Example
The example request parameters and headers are set as follows:
section
is set totest_section
Code Block |
---|
DELETE /api/v1/registry/test_section/ HTTP/1.1 Host: {{playerIP}} Authorization: {{ |
...
DigestAuth}} Accept: application/json |
Response Body
success
bool: A flag indicating whether the registry section was deletedsection
string: This flag is set to the registry section
Response Example
Code Block | ||
---|---|---|
| ||
{
"data": {
"result": {
"success": true,
"section": "test_section"
}
}
} |
GET /v1/registry/recovery_url/
Retrieves the recovery URL stored in the player registry
Request Example
recovery_url
is the recovery URL in the player registry
Code Block |
---|
GET /api/v1/registry/recovery_url/ HTTP/1.1
Host: {{ |
...
playerIP}} Authorization: {{DigestAuth}} Accept: application/json |
Response Body
success
bool: A flag indicating whether the request was successfully readvalue
string: The recovery URL
Response Example
Code Block | ||
---|---|---|
| ||
{
"data": {
"result": {
"success": true,
"value": "https://handlers.bsn.cloud//recovery/recovery.ashx"
}
}
} |
PUT /v1/registry/recovery_url/
Updates the recovery URL in the player’s registry.
Request Body
url
string: The value of the recovery URL
Request Example
The example request parameters and headers are set as follows:
url
is set towww.google.com
Code Block |
---|
PUT /api/v1/registry/recovery_url/ HTTP/1.1 Host: {{ |
...
playerIP}} Authorization: {{DigestAuth}}} Accept: application/json Content-Type: application/json Content-Length: 37 |
Request Body
Code Block | ||
---|---|---|
| ||
{
"url": "www.google.com"
} |
Response Body
Endpoints:
...
success
bool: A flag indicating whether the write was successful
Response Example
Code Block | ||
---|---|---|
| ||
{
"data": {
"result": {
"success": true
}
}
} |