Release: Wombat

Wombat is the current DocsHub architecture.

Read the Roadmap

StaxLens API reference #

All endpoints require a Authorization: Bearer <token> header. The token resolves to a tenant, and every read is scoped to that tenant.

POST /api/v1/ingest #

Agent report. Body is a JSON sample:

{
  "agentId": "web-01",
  "hostname": "web-01",
  "platform": "linux",
  "ts": 1690000000000,
  "cpu": { "usage": 12, "perCore": [12], "loadAverage": [0, 0, 0] },
  "memory": { "total": 100, "used": 50, "free": 50, "percent": 50 },
  "disks": [{ "path": "/", "total": 100, "used": 10, "available": 90, "percent": 10 }],
  "network": {},
  "services": [],
  "alerts": []
}

• If the collector was started with --secret, the request must also carry an x-stax-signature HMAC-SHA256 header; unsigned or mismatched payloads are rejected with 401.
• Returns 200 on success. If any alert routing failed, returns 202 with alertResults.

GET /api/v1/hosts #

Returns the list of host ids reporting for the token’s tenant.

["web-01", "web-02"]

GET /api/v1/host/:id?from=&to= #

Returns the time-series for one host within [from, to] (epoch ms). When the point count exceeds the budget, the series is downsampled by averaging into buckets. Metrics are flattened (cpu.usage, memory.percent, disk./.percent, …).

GET /api/v1/aggregate?from=&to= #

Returns an averaged series across all of the tenant’s hosts for a fleet-wide view.

GET / #

Serves the per-tenant dashboard (HTML) showing each host’s latest CPU and memory.