RCWeb Endpoint Documentation

This document lists all the public HTTP and WebSocket endpoints exposed by the RCWeb server.

1. System Endpoints

Standard endpoints for site metadata and search engine optimization.

Path	Method	Description
/favicon.ico	GET	Returns the site favicon.
/robots.txt	GET	Search engine crawler instructions.
/sitemap.xml	GET	XML sitemap for search engines.
/humans.txt	GET	Information about the people who built the site.
/security.txt	GET	Security contact information (RFC 9116).
/ads.txt	GET	Authorized Digital Sellers list.
/.well-known/*	GET	ACME domain verification and other well-known services.

2. Service Endpoints

Utility services provided by the server.

Path	Method	Description
/speedtest/*	GET	Endpoints for testing network throughput.
/tncaptcha.gif	GET	Generates a Temporal Noise Captcha image.
/javadoc/*	GET	Serves the project's Java documentation.
/assets/*	GET	Serves static assets (CSS, JS, images, etc.).
/docs/*	GET	Serves system documentation pages.

3. API Endpoints

Internal monitoring and management APIs.

Path	Method	Description
/api/health-check	GET	Returns a JSON health status report.
/api/health-check.websocket	WS	Real-time health monitoring via WebSocket.
/api/http-request-log.websocket	WS	Stream of incoming HTTP requests for monitoring.
/api/websocket-frame-log.websocket	WS	Stream of WebSocket frames for monitoring.
/api/invalidate-cache	GET	Clears all internal caches (classpath, javadoc, speedtest).
/x-file/*, /x-chunk/*	GET	Proxies file requests from connected clients.

4. Application Endpoints

Endpoints used by RCWeb Apps to maintain real-time communication.

Path	Method	Description
/{app}/	GET	Entry point for an RCWeb app. Redirects to include a roomId if missing.
/{app}/app.websocket	WS	The primary WebSocket connection for an app. Required: r (roomId) and c (clientId).
/{app}/webmanifest.json	GET	Dynamic PWA manifest for the specific app and room.

Parameters:

• r: Room ID (Unique session identifier).
• c: Client ID (Unique identifier for the connection).