diff options
Diffstat (limited to 'config.example.yaml')
| -rw-r--r-- | config.example.yaml | 19 |
1 files changed, 14 insertions, 5 deletions
diff --git a/config.example.yaml b/config.example.yaml index 91d17e9..1aa725a 100644 --- a/config.example.yaml +++ b/config.example.yaml @@ -370,18 +370,27 @@ incidents: # 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/monitor/{group}/{name} +# - Single monitor status JSON +# GET /api/history/{group}/{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 +# GET /api/uptime/{group}/{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) -# GET /api/badge/{name}.svg - SVG status badge (always public, shields.io style) +# GET /api/badge/{group}/{name}.svg +# - SVG status badge (always public, shields.io style) # Supports: ?label=custom&style=flat|plastic&type=status|uptime -# Example:  +# Example:  +# POST /api/reload - Reload configuration (always requires API key) +# Returns: {"status": "ok", "message": "Configuration reloaded successfully"} +# +# Note: Monitor endpoints use {group}/{name} path format. URL-encode slashes in names. +# Example: /api/monitor/Services/API or /api/monitor/A%2FB%20Tests/Variant%20A # # Authentication (when access is "authenticated"): # - Header: X-API-Key: your-secret-key |