aboutsummaryrefslogtreecommitdiff
path: root/config.example.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'config.example.yaml')
-rw-r--r--config.example.yaml3
1 files changed, 3 insertions, 0 deletions
diff --git a/config.example.yaml b/config.example.yaml
index 706e3dc..91d17e9 100644
--- a/config.example.yaml
+++ b/config.example.yaml
@@ -379,6 +379,9 @@ incidents:
# 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)
+# Supports: ?label=custom&style=flat|plastic&type=status|uptime
+# Example: ![Status](https://status.example.com/api/badge/Website.svg)
#
# Authentication (when access is "authenticated"):
# - Header: X-API-Key: your-secret-key