Control

List windows

What is on the desktop, as a list rather than a picture — id, title, class, type, geometry and which one has focus. Cheaper and more reliable than asking a model to find a window in a screenshot.

A Windows computer answers 400 with reason: "unsupported": listing windows is not supported on Windows guests yet. A stopped or suspended computer answers 409 with reason: "unavailable", since this read does not resume one: start it first.

Requires the viewer role or higher.

get/computers/{id}/windows

Request

  • Base URL: https://app.mandala.computer/api/v1
  • URL: https://app.mandala.computer/api/v1/computers/{id}/windows
  • Auth: HTTP bearer

Path parameters

idstring required

The computer id.

Query parameters

include'all'

Include the desktop’s own furniture — panels, docks, the wallpaper window. Left out by default because none of it is a window a caller wants to act on.

Response

The windows currently open.

Changes

No recorded changes to this operation across all 1 revision of this API.