From f8407939ed142b38de08c4ec9e81467cf19ad8be Mon Sep 17 00:00:00 2001
From: Vinothini Raju <vinothiniraju@Apples-MacBook-Pro-2.local>
Date: Wed, 18 Nov 2020 17:08:00 +0530
Subject: [PATCH] REST API calls added

---
 README.md | 93 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 93 insertions(+)

diff --git a/README.md b/README.md
index 24072ea..39ca283 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,95 @@
 # sail
 Migrate Linux Processes to Docker Containers
+
+# Prerequisite
+```sh
+sudo groupadd docker
+sudo usermod -aG docker <current-user-name>
+```
+Restart is required after adding user to docker group
+## 1. Process List API
+```
+URL : /api/{accountID}/v1/listProcesses?cmd=nvim
+Method : GET
+Response :
+{
+    "pid": "93167",
+    "cmd": "nvim ALACRITTY_LOG=/tmp/Alacritty-93120.log COLORTERM=truecolor DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/1000/bus DESKTOP_SESSION=i3-with-shmlog DISPLAY=:0 GDMSESSION=i3-with-shmlog GDM_LANG=en_US.UTF-8 GTK_MODULES=canberra-gtk-module HOME=/home/kryptiksage I3SOCK=/run/user/1000/i3/ipc-socket.1000 LANG=en_US.UTF-8 LOGNAME=kryptiksage MAIL=/var/spool/mail/kryptiksage MOTD_SHOWN=pam PATH=/home/kryptiksage/.cargo/bin/:/home/kryptiksage/.scripts/:/usr/local/bin:/usr/local/sbin:/usr/bin:/usr/bin/site_perl:/usr/bin/vendor_perl:/usr/bin/core_perl PWD=/home/kryptiksage SHELL=/bin/zsh SHLVL=1 TERM=alacritty USER=kryptiksage USERNAME=kryptiksage WINDOWID=60817410 WINDOWPATH=2 XAUTHORITY=/run/user/1000/gdm/Xauthority XDG_DATA_DIRS=/home/kryptiksage/.local/share/flatpak/exports/share:/var/lib/flatpak/exports/share:/usr/local/share:/usr/share XDG_RUNTIME_DIR=/run/user/1000 XDG_SEAT=seat0 XDG_SESSION_CLASS=user XDG_SESSION_DESKTOP=i3-with-shmlog XDG_SESSION_ID=3 XDG_SESSION_TYPE=x11 XDG_VTNR=2 OLDPWD=/home/kryptiksage TERMINAL=alacritty P9K_TTY=old HISTSIZE=10000 SAVEHIST=10000 HISTFILE=/home/kryptiksage/.zsh_history P9K_SSH=0 _=/usr/bin/nvim",
+    "ppid": "93125",
+    "uid": "1000",
+    "gid": "1000",
+    "time": "5"
+}
+```
+## 2. Trace API
+```
+URL : /api/{accountID}/v1/startTracing?pid=93167
+Method : PUT
+Request :
+{
+   "time": 2
+}
+```
+## 3. Get files and packages
+```
+URL : /api/{accountID}/v1/getfilepkg
+Method : GET
+```
+## 4. Get ports
+```
+URL : /api/{accountID}/v1/getports
+Method : GET
+```
+## 5. Get NFS mounts
+```
+URL : /api/{accountID}/v1/getNfsMounts
+Method : GET
+```
+## 6. Get Environment variables
+```
+URL : /api/{accountID}/v1/getenv
+Method : GET
+```
+## 7. Get Default shell
+```
+URL : /api/{accountID}/v1/getshell
+Method : GET
+```
+## 8. Get UID and GID
+```
+URL : /api/{accountID}/v1/getuser
+Method : GET
+```
+## 9. Get Start Command
+```
+URL : /api/{accountID}/v1/getstartcmd
+Method : GET
+```
+## 10. Docker Create dev container
+```
+URL : /api/{accountID}/v1/dockercreate
+Method : PUT
+Request(Optional) :
+{
+   "osname": "archlinux",
+   "osver": "latest"
+}
+```
+## 11. Docker Copy Files to dev container
+```
+URL : /api/{accountID}/v1/dockercopy
+Method : PUT
+Request :
+{
+    "dirs": ["testdir", "testfile.txt"]
+}
+```
+## 12. Final docker image creation
+```
+URL : /api/{accountID}/v1/finalimage
+Method : PUT
+Request :
+{
+    "home": "home_directory"
+}
+```