Actions
Scroll
Move the pointer to a coordinate and scroll the wheel up or down there.
POST
Scroll
Moves the pointer to
x, y and scrolls the wheel there. A Windows computer scrolls at the pointer’s current position instead.
A Windows computer scrolls at the pointer’s current position and ignores
?screen=. Send it only direction and amount, both required: direction
must be up or down and amount from 1 to 50. Any other field,
including x and y, or a value outside those rules returns 400. A
successful response is {"ok": true}.Path parameters
Query parameters
Which screen to scroll 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. A Windows computer ignores this
parameter.Body parameters
X coordinate to move the pointer to before scrolling, in pixels from the left
edge. Nominally optional, but omitting it moves the pointer to
x = 0. See
the warning above. A Windows computer refuses this field with 400.Y coordinate to move the pointer to before scrolling, in pixels from the top
edge. Nominally optional, but omitting it moves the pointer to
y = 0. See
the warning above. A Windows computer refuses this field with 400.Scroll direction:
up or down. Optional on Linux: omitting it scrolls down,
and so does any value other than the exact string up. Required on Windows.Number of wheel clicks. Optional on Linux: omitting it, or sending
0,
scrolls once, and a negative value moves the pointer, scrolls nothing, and
still returns 200. Required on Windows, from 1 to 50.Response
Carries
direction and amount after defaults are applied. The coordinates
the pointer was moved to are not echoed back.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
Scroll performed