Welcome to PyLot Documentation

API Documentation

User Account Management

Create User [POST]

• Path : /users/signup
• Params :
  • firstName : User’s First Name (String)
  • lastName : User’s Last Name (String)
  • username : Username (String).
  • password : Password (String).
  • email : User’s email address (String).

    {
    firstName: "John",
    lastName: "Doe",
    username: "johndoe123",
    password: "testpass",
    email: "john.doe@snailmail.com
    }
    

Add Server [POST]

• Path : /users/addserver
• Params :
  • username : Username (String).
  • serverName : Server’s name (String) [A user cannot have multiple servers with the same name].
  • ipAddr : Server IP address.
  • sshKey : Password field contains SSH Key (Boolean).
  • password : Server password (String).

    Example
    {
    username: "johndoe123",
    serverName: "server-1",
    ipAddr: "192.168.1.1",
    sshKey: false,
    password: "serverpassowrd1"
    }
    

Remove Server [POST]

• Path : /users/removeserver
• Params :
  • username : Username (String).
  • serverName : Server Name (String).

    Example
    {
    username: "johndoe123",
    serverName: "server-1",
    }
    

Fetch Servers [POST]

• Path : /users/getservers
• Params :
  • username : Username (String).
  • password : Password (String).

    Example
    {
    username: "johndoe123",
    password: "testpass",
    }
    

    Setup Health Server [POST]

• Path : /health/setupserver
• Params :
  • username : Username (String).
  • serverName : Server Name (String).

    Example
    {
    username: "johndoe123",
    serverName:"server-2"
    }
    

    Display Health Data from Server [POST]

• Path : /health/display
• Params :
  • serverName : Server Name (String).
  • details : details (String).

    Example
    {
    serverName:"test"
    details:"all" or"last10" or "first10"
    }
    

Bash Commands that are required for automated login into remote server

git clone https://github.com/mathewpius19/Server-Health-Monitor-v2.git
cd Server-Health-Monitor-v2
chmod 777 requirements.py
chmod 777 report.py
```password, servername and username will be passed on by our backend```
echo {password}|sudo -S apt install python3-pip
pip3 install psutil
pip3 install requests
python report.py {servername} {username}