diff options
| author | Ben Morrison <ben@gbmor.dev> | 2020-05-07 17:04:52 -0400 |
|---|---|---|
| committer | Ben Morrison <ben@gbmor.dev> | 2020-05-07 17:04:52 -0400 |
| commit | 693efbb4a96f6f4ea195a63d563f355d03206de1 (patch) | |
| tree | 6e9bbfa9446275a6ab42b50821656e2a0c89cd91 /web | |
| parent | c437381aa8fb5d185b45724daadfc1a18c0cccb8 (diff) | |
| download | api-693efbb4a96f6f4ea195a63d563f355d03206de1.tar.gz | |
tentative index page
Diffstat (limited to 'web')
| -rw-r--r-- | web/index.txt | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/web/index.txt b/web/index.txt new file mode 100644 index 0000000..d108168 --- /dev/null +++ b/web/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 |