Skip to content

High-performance browser automation bridge and multi-instance orchestrator with advanced stealth injection and real-time dashboard.

docs: update /health endpoint reference for dashboard mode

Boschea284b50e072
diff --git a/docs/reference/health.md b/docs/reference/health.md
index 2fe6a8fe..81e4fed6 100644
--- a/docs/reference/health.md
+++ b/docs/reference/health.md
@@ -1,6 +1,8 @@
# Health
-Check whether the current browser context is available and how many tabs are open.
+Check server status and availability.
+
+## Bridge Mode
```bash
curl http://localhost:9867/health
@@ -15,11 +17,54 @@ pinchtab health
Notes:
-- this is a shorthand route for the current browser context
-- in error cases it returns `503` with `status: "error"`
+- returns tab count for the attached browser
+- in error cases returns `503` with `status: "error"`
+
+## Server Mode (Dashboard)
+
+```bash
+curl http://localhost:9867/health
+# Response
+{
+ "status": "ok",
+ "mode": "dashboard",
+ "version": "0.8.0",
+ "uptime": 12345,
+ "profiles": 1,
+ "instances": 1,
+ "defaultInstance": {
+ "id": "inst_abc12345",
+ "status": "running"
+ },
+ "agents": 0,
+ "restartRequired": false
+}
+```
+
+| Field | Description |
+|-------|-------------|
+| `status` | `ok` when server is healthy |
+| `mode` | Always `dashboard` in server mode |
+| `version` | PinchTab version |
+| `uptime` | Milliseconds since server start |
+| `profiles` | Number of configured profiles |
+| `instances` | Number of running browser instances |
+| `defaultInstance` | First managed instance info (if any) |
+| `defaultInstance.id` | Instance ID |
+| `defaultInstance.status` | `starting`, `running`, `stopping`, `stopped`, `error` |
+| `agents` | Number of connected agents |
+| `restartRequired` | True if config changes need restart |
+| `restartReasons` | List of reasons (when `restartRequired` is true) |
+
+Notes:
+
+- `defaultInstance` is present when at least one instance is running
+- use `defaultInstance.status == "running"` to check Chrome is ready
+- strategies like `always-on` launch an instance at startup
## Related Pages
- [Tabs](./tabs.md)
- [Navigate](./navigate.md)
+- [Strategies](./strategies.md)