https://github.com/kissgyorgy/linux-rest-api

A REST API for Linux
https://github.com/kissgyorgy/linux-rest-api

linux python python3 rest-api system uptime

Last synced: 17 days ago
JSON representation

A REST API for Linux

• Host: GitHub
• URL: https://github.com/kissgyorgy/linux-rest-api
• Owner: kissgyorgy
• Created: 2018-08-07T22:06:32.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-02-02T11:47:20.000Z (almost 2 years ago)
• Last Synced: 2023-08-03T22:26:25.328Z (over 1 year ago)
• Topics: linux, python, python3, rest-api, system, uptime
• Language: Python
• Size: 61.5 KB
• Stars: 3
• Watchers: 4
• Forks: 2
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# linux-rest-api - A REST API for Linux!

It makes it possible to configure your entire system (well, parts which are implemented) 

via a REST API. The main advantage is that you don't have to parse all kind of 

configuration files, it is a community effort, all kind of parsers are implemented.

It's the modern version of [Webmin](http://www.webmin.com/).

Examples:

- Add a `pg_hba.conf` entry and reload PostgreSQL configuration.

- Enable/disable a website for nginx and reload.

- Get system state like uptime, free memory or disk space. (Make it easier to monitor.)

- Upgrade your system in an automated way (e.g. apt-get upgrade)

- Stop/start systemd services

- Get status about services

- You can use it as a building block for your appliance.

## Features

- Upload a file anywhere on the filesystem

- Download any file from the system

- Get information about the System (os-release, uptime, kernel version, etc.)

## Security

The process should be run as root, and it should not be exposed to the internet directly,

because it would open a huge security risk on your box.

It's best to use on a closed, trusted internal network, and it still should be protected

by strong authentication over HTTPS. (e.g. with client certificates AND token)

## Requirements

- Any kind of Linux system

- Python 3.6+

- gcc (for installing psutil) or the psutil package pre-installed