diff options
author | Ben Morrison <ben@gbmor.dev> | 2020-05-20 02:54:24 -0400 |
---|---|---|
committer | Ben Morrison <ben@gbmor.dev> | 2020-05-20 02:54:24 -0400 |
commit | b2b262faa56be956cb515e54db2fa5d016c88c36 (patch) | |
tree | de2eda19672d0fbbdbb8787a4cb140642d8655bf /static | |
parent | 55f346f7aaed303f956ceb95bce8e8aa0a5ea28f (diff) | |
download | api-b2b262faa56be956cb515e54db2fa5d016c88c36.tar.gz |
renamed web/ -> static/ as it's more descriptive
Diffstat (limited to 'static')
-rw-r--r-- | static/index.txt | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/static/index.txt b/static/index.txt new file mode 100644 index 0000000..d108168 --- /dev/null +++ b/static/index.txt @@ -0,0 +1,28 @@ +This is the tilde.institute informational API + +Not finished. Currently planning: + + / + - Information on endpoints and purpose + + /[plain|json] + - Response formats + + /$FMT/osversion + - OpenBSD version + + /$FMT/pkgs + - Installed packages + + /$FMT/query + ?pkg=[a-zA-Z0-9+] + - Check if a package is installed. + + /$FMT/uptime + - Uptime and Load + + /$FMT/usercount + - Number of registered user accounts + + /$FMT/users + - List of users (maybe CSV for plaintext?) and ancillary information |