From 30e524151ffba05fdad7146173e93aa0fa7f690c Mon Sep 17 00:00:00 2001 From: Kasm <44181855+kasmtech@users.noreply.github.com> Date: Mon, 5 Apr 2021 14:07:21 -0400 Subject: [PATCH] Updated API (markdown) --- API.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/API.md b/API.md index 4b498f1..2067610 100644 --- a/API.md +++ b/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 \ No newline at end of file