v48

latestOpenAPI 3.0.0raw.githubusercontent.com2025-12-0297180624.8 KB

Box

Get box display

Retrieve the current display properties for a running box. This endpoint provides details about the box's screen resolution, orientation, and other visual properties.

get/boxes/{boxId}/display

Path parameters

boxIdstring required

Example:c9bdc193-b54b-4ddb-a035-5ac0c598d32d

Box ID

Response

Box display properties

orientation'portrait' | 'landscapeLeft' | 'portraitUpsideDown' | 'landscapeRight' required

Orientation of the box

Example response

{
  "resolution": {
    "width": 1920,
    "height": 1080
  },
  "orientation": "portrait"
}