go-pugleaf BBS Help System
Your guide to navigating the NNTP newsgroup interface
RESTful API Endpoints
Authentication Required: Most API endpoints require the
X-API header with a valid token. Only /api/v1/stats is publicly accessible.
Authentication Method
API endpoints require authentication via the X-API custom header:
X-API: your-api-token-here
Public Endpoint
The following endpoint is publicly accessible without authentication:
GET /api/v1/stats
System statistics and performance metrics
Token Management: API tokens are managed through the admin interface. Contact your system administrator for access.
Authentication Required: These endpoints require the
X-API header.
GET /api/v1/groups
List all available newsgroups with metadata
GET /api/v1/groups/:group/overview
Get article overview for a specific newsgroup
GET /api/v1/groups/:group/threads
Get threaded view of conversations in a group
GET /api/v1/groups/:group/articles/:num
Get specific article by article number
GET /api/v1/groups/:group/message/:messageId
Get specific article by message ID
Response Format: All API endpoints return JSON data with appropriate HTTP status codes.
Rate Limiting: API calls may be rate-limited during high traffic periods.
API Usage Examples
Note: Replace
your-api-token with your actual API token. Only /api/v1/stats is public.
Public Endpoint (No Auth Required)
curl https://go-pugleaf.newsdeef.eu/api/v1/stats
Get All Newsgroups (Auth Required)
curl -H "X-API: your-api-token" \
https://go-pugleaf.newsdeef.eu/api/v1/groups
Get Group Articles (Auth Required)
curl -H "X-API: your-api-token" \
https://go-pugleaf.newsdeef.eu/api/v1/groups/alt.comp.freeware/overview
Get Specific Article (Auth Required)
curl -H "X-API: your-api-token" \
https://go-pugleaf.newsdeef.eu/api/v1/groups/alt.comp.freeware/articles/123
Get Thread View (Auth Required)
curl -H "X-API: your-api-token" \
https://go-pugleaf.newsdeef.eu/api/v1/groups/alt.comp.freeware/threads
Authentication Errors: Missing or invalid
X-API header will return HTTP 401 Unauthorized.