Created API (markdown)

Kasm 2021-04-04 06:41:34 -04:00
parent 8982c9fa7f
commit 8497fb48de

34
API.md Normal file

@ -0,0 +1,34 @@
KasmVNC has an API to make changes or get data via simple HTTPS API calls.
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
width - defaults to actual remote screen width
height - defaults to actual remote screen height
quality - JPEG quality, defaults to 7
deduplicate - set to true if you want the API call to return nothing if the screenshot has not changed since the last request
### Add User
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)
example: /api/create_user?name=fred&password=123&write=true
### Remove User
Remove a user from the KasmVNC session
/api/remove_user
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