Powered by Redocly

/config/display/backlight

The backlight configuration of the display.

Get /config/display/backlight

SecurityApiKey
Request
query Parameters
max-depth
integer >= 1

Limit output depth of the response. See Max-Depth.

Example: max-depth=2
filter
string

Response filter string. See Filter-Spec.

Example: filter={foo,bar}
Responses
200

Normal response.

401

Unauthorized response.

get/config/display/backlight
Request samples 
Response samples 
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}
Replace /config/display/backlight
SecurityApiKey 
Request 
Request Body schema: application/json
brightness
integer (configDisplayBacklightBrightness)   [ 0 .. 255 ] 
The brightness of the backlight.  Zero is darkest (backlight off),
255 is the brightest.


 
duration
integer <int32>  (configDisplayBacklightDuration)   [ -1 .. 2147483647 ] 
The number of seconds the backlight should remain on after the
last activation of the display navigation buttons.  Zero means the
backlight is always off.  The special value -1 indicates that the
backlight remains on at all times.


 
Responses 
200
Normal response.


401
Unauthorized response.


put/config/display/backlight
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /config/display/backlight
SecurityApiKey 
Request 
Request Body schema: application/json
brightness
integer (configDisplayBacklightBrightness)   [ 0 .. 255 ] 
The brightness of the backlight.  Zero is darkest (backlight off),
255 is the brightest.


 
duration
integer <int32>  (configDisplayBacklightDuration)   [ -1 .. 2147483647 ] 
The number of seconds the backlight should remain on after the
last activation of the display navigation buttons.  Zero means the
backlight is always off.  The special value -1 indicates that the
backlight remains on at all times.


 
Responses 
200
Normal response.


401
Unauthorized response.


post/config/display/backlight
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Delete /config/display/backlight
Reset to default. See the descriptions of the individual endpoints for their default values.  Commonly, arrays and strings are cleared to empty, numbers are cleared to 0, and booleans are cleared to false.  


SecurityApiKey 
Responses 
200
Normal response.


401
Unauthorized response.


delete/config/display/backlight
Request samples 
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
➔ Next to /config/display/backlight/brightness