Actions
Press key
Press a single key or a key combination like ctrl+c.
POST
Presses a key or key combination. Join a combination with
+, for example ctrl+shift+t.
On a Windows computer the response is
{"ok": true}. Key names are not case-sensitive and follow Windows naming, so Page_Up and Page_Down are spelled pageup and pagedown; the other keys in the tables below work as written. A missing or unrecognised key returns 400 rather than 500, and the error body reads Request failed with status code 400 rather than saying why. ?screen= is ignored.Path parameters
Query parameters
Which screen to press the key on. Optional.
Omit it to act on the screen the computer booted with. An unknown id returns
404 rather than falling back to the default screen.Body parameters
Key or key combination to press. On Linux the value is passed through to the computer’s
keyboard driver unchanged, so it must be an X11 keysym name. Keysym names are
case-sensitive. Nothing validates the field before it gets there: a missing or
misspelled key surfaces as a
500, not a 400.Common keys
Use the keysym name, not the label printed on the key.Return and BackSpace
are the two that most often catch people out.
Common combinations
The modifier names are
ctrl, alt, shift, and super.
Response
Example
Response
Errors
Every failure raised after the request leaves the API layer also carries a
request_id. Quote it in support requests. When the computer agent itself
answered non-2xx, the body additionally carries upstream_status.
Authorizations
Query Parameters
Body
application/json
Response
Key pressed