Updated API (markdown)

Kasm 2021-04-05 14:07:21 -04:00
parent 8497fb48de
commit 30e524151f

8
API.md

@ -5,7 +5,8 @@ All API calls require owner credentials.
### Get Screenshot
Get a screenshot of the current session. You can pass a height and width that do not match the current aspect ratio, it will return the requested width with the height adjusted to keep the aspect ratio.
/api/get_screenshot
/api/get_screenshot
width - defaults to actual remote screen width
height - defaults to actual remote screen height
quality - JPEG quality, defaults to 7
@ -15,6 +16,7 @@ Get a screenshot of the current session. You can pass a height and width that do
Add another user to the session.
/api/create_user
name - the username
password - the requested password
write - set to 'true' if the user should have write permissions (control of mouse and keyboard)
@ -25,10 +27,12 @@ example: /api/create_user?name=fred&password=123&write=true
Remove a user from the KasmVNC session
/api/remove_user
name - username of the user to remove
name - username of the user to remove
### Give control to another user
Give session control (mouse and keyboard control) to another user
/api/give_control
name - Username to give control to