GitHub - tildeinstitute/api: HTTP API for querying information from tilde.institute. Mirror.

tildeinstitute / api Public

Notifications You must be signed in to change notification settings
Fork 0
Star 2

HTTP API for querying information from tilde.institute. Mirror.

git.tilde.institute/tilde/api

MIT license

2 stars 0 forks Branches Tags Activity

Star

Notifications

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 42 Commits
static		static
.gitignore		.gitignore
LICENSE		LICENSE
Makefile		Makefile
README		README
cache.go		cache.go
ctx.go		ctx.go
go.mod		go.mod
http.go		http.go
logging.go		logging.go
main.go		main.go
osversion.go		osversion.go
pkgs.go		pkgs.go
query.go		query.go
uptime.go		uptime.go
usercount.go		usercount.go
users.go		users.go

Repository files navigation

:: Informational API for tilde.institute ::

This allows one to query information and stats via HTTP requests. GET and
HEAD methods are allowed. All others will receive a 405 response. Responses
will be cached for a short period of time (5m?). Subsequent queries in that
time frame will be served from the cache.

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

Probably going to add more endpoints.