Skip to main content

Public Endpoints

These endpoints do not require authentication.

Server Info

Get server version and information.
Response:

Health Check

Check if the server is running.
Response:

Readiness Check

Check if the server is ready to accept requests.
Response:

Swagger Documentation

Access the interactive Swagger UI documentation.

Web UI

The web UI is served at the root path. It uses embedded UI files by default, with an option to serve from an external path.
UI Serving Priority:
  1. If ui_path is configured and exists, serves from that directory
  2. Otherwise, serves embedded UI files from public/ui/

Workspace Files

Scan output files can be accessed directly via the workspace path. This endpoint is only available when workspace_prefix is configured in server settings.
The workspace path serves files from the configured workspaces directory with directory listing enabled.