proc-api/README.md

26 lines
533 B
Markdown
Raw Permalink Normal View History

2022-04-29 19:20:19 +00:00
Proc-API
2022-04-28 20:48:15 +00:00
==========
2022-04-29 19:20:19 +00:00
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
2022-04-29 20:31:21 +00:00
How do I talk to the API?
-------------------------
2022-04-29 19:20:19 +00:00
See [DOCUMENTATION.md](DOCUMENTATION.md)
2022-04-29 20:31:21 +00:00
Features/TODO
-------------
* [X] Basic routing
* [X] Authentication
* [ ] Support for querying a PID