diff options
| author | Fuwn <[email protected]> | 2026-01-20 16:49:50 -0800 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2026-01-20 16:49:50 -0800 |
| commit | 31cc0a33a378dbc8cb0e3c70b40d6570f3bed2e4 (patch) | |
| tree | 6de6f3354af8095be83740b3b24ca1490892a999 /config.example.yaml | |
| parent | perf: Optimize API refresh to single /api/page request (diff) | |
| download | kaze-31cc0a33a378dbc8cb0e3c70b40d6570f3bed2e4.tar.xz kaze-31cc0a33a378dbc8cb0e3c70b40d6570f3bed2e4.zip | |
feat: Add new API endpoints (health, summary, uptime, incidents)
New endpoints:
- GET /api/health - Simple health check, always public (for load balancers)
- GET /api/summary - Lightweight status overview (counts + overall status)
- GET /api/uptime/{name}?period=1h|24h|7d|30d|90d - Historical uptime stats
- GET /api/incidents?filter=all|active|resolved|scheduled - List incidents
All new endpoints (except /api/health) follow api.access rules.
Diffstat (limited to 'config.example.yaml')
| -rw-r--r-- | config.example.yaml | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/config.example.yaml b/config.example.yaml index 624e1d0..706e3dc 100644 --- a/config.example.yaml +++ b/config.example.yaml @@ -367,11 +367,18 @@ incidents: # keys: []string - List of valid API keys (for "authenticated" mode) # # Endpoints: +# GET /api/health - Simple health check (always public) +# Returns: {"status": "ok"} # GET /api/status - All monitors status JSON # GET /api/monitor/{name} - Single monitor status JSON # GET /api/history/{name} - Monitor history (supports ?mode=ping|minute|hour|day&count=N) # GET /api/page - Full page data (monitors + history + status) in one request # Note: Always public when refresh_mode is "api" +# GET /api/summary - Lightweight status overview (counts + overall status, no history) +# GET /api/uptime/{name} - Historical uptime stats for a monitor +# Supports ?period=1h|24h|7d|30d|90d (default: 24h) +# GET /api/incidents - List incidents from config +# Supports ?filter=all|active|resolved|scheduled (default: all) # # Authentication (when access is "authenticated"): # - Header: X-API-Key: your-secret-key |