API reference

Everything lives under /api and speaks JSON; errors are {status, message} and timestamps are Unix seconds. The "try it" calls hit the live server. Write requests (POST/PATCH/PUT/DELETE) are sent with X-Dry-Run: true, so the backend echoes what it received and changes nothing.

Public view. Admin routes appear once you're signed in as an admin.

Webring public

The ring itself. Contains the server metadata, members and the redirect endpoints.

• GET /api/server-info Name, version, authors, uptimes.
• GET /api/uptime App and host uptime.
• GET /api/stats Ring counters.
• GET /api/users Verified members in ring order.
• GET /api/users/random Redirects to a random member's site.
• GET /api/ads All verified ads.
• GET /api/ads/random A random verified ad.
• GET /user/:name Redirects to that member's url (:name={username} explains itself).
• GET /user/:name/next Next site in the ring.
• GET /user/:name/prev Previous site in the ring.
• GET /user/:name/random Jump to a random site.
• GET /api/user/:name Alias of /user/:name.
• GET /api/user/:name/next Alias of /user/:name/next.
• GET /api/user/:name/prev Alias of /user/:name/prev.
• GET /api/user/:name/random Alias of /user/:name/random.

Newsletter public

Public posts and the RSS feed.

• GET /newsletter/feed.xml RSS 2.0 feed.
• GET /api/newsletter Published posts, newest first (drafts and future-dated posts hidden).
• GET /api/newsletter/:id One post by id or slug.
• WS /api/newsletter/ws Live newsletter changes (create/update/delete).

Join the ring public

Open signup, rate-limited per IP (5/min soft, plus a long-window hard cap).

• POST /api/users Register a site; returns a one-time manage token. 429 when over the per-IP soft (5/min) or hard cap.

Manage your entry manage

Self-service for a member's ring entry and ad, gated by the token minted at signup.

Authorization: Bearer <manage_token>

• GET /api/manage Your user entry.
• PATCH /api/manage Update url and/or contact (a new url also rewrites your ad's url).
• DELETE /api/manage Delete yourself from the ring.
• GET /api/manage/ad Your ad.
• POST /api/manage/ad Submit an ad (ad_url auto-follows your url).
• PATCH /api/manage/ad Change the ad image.
• DELETE /api/manage/ad Remove your ad.