proc-api/README.md
2022-04-29 16:31:21 -04:00

26 lines
533 B
Markdown

Proc-API
==========
This is a lightweight, fast, RESTful API designed around the /proc filesystem
in linux. It allows for stateless monitoring of remote linux systems with
automated tools.
What is this good for?
----------------------
* Remote monitoring
* Collecting stats on a remote system
* Client applications for VPS hosters
How do I talk to the API?
-------------------------
See [DOCUMENTATION.md](DOCUMENTATION.md)
Features/TODO
-------------
* [X] Basic routing
* [X] Authentication
* [ ] Support for querying a PID