README


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

:: Informational API for tilde.institute ::

This allows one to request information and stats via HTTP requests. The GET and
HEAD methods are allowed. All others will receive a 405 response.

Not finished. Currently planning:

    FMT = /{plain|json}
        - Plaintext or JSON formatted responses

    $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


I'll use some kind of fast hash as an etag.

Probably going to add more endpoints.