snxraven/peardata
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update Docs
CI / test (push) Successful in 1m1s
Details
Release rolling / release (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Raven Scott
2026-07-19 13:35:19 -04:00
parent 584e1c9c42
commit 5521f2952a
25 changed files with 191 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/REST-API.md
+9 -4
View File
@@ -45,7 +45,7 @@ curl -s http://127.0.0.1:18888/api/v3/health | jq
| GET | `/api/v3/db` | HyperDB public/discovery keys + collections |
| GET | `/api/v3/versions` | Agent / protocol / API versions |
| GET | `/api/v3/me` | Anonymous REST identity note |
| GET | `/api/v3/settings` | Runtime knobs + retention + storage usage summary |
| GET | `/api/v3/settings` | Runtime knobs + **retention** + **storage usage** summary (Data Manager read model) |
| GET | `/api/v3/config` | alias of settings |
| GET | `/health`, `/api/v1/health`, `/api/v3/health` | Aggregate health |
@@ -168,7 +168,7 @@ Desktop walkthrough: [user-guide/logs.md](../user-guide/logs.md)
| Param | Notes |
|-------|--------|
| `source` | `anomaly` (API default) \| `audit` \| `journal` — desktop UI defaults to **journal** for admins |
| `source` | `journal` (default) \| `anomaly` \| `audit` — desktop prefers **journal** for admins |
| `q` | Case-insensitive substring over message / unit / severity |
| `since` / `until` | Absolute ms/sec, ISO, or relative (`-1h`) |
| `priority` | Journal max priority (`journalctl -p`) |
@@ -177,10 +177,14 @@ Desktop walkthrough: [user-guide/logs.md](../user-guide/logs.md)
**Auth:** REST is localhost-open (like other GETs). Over P2P, `audit` and `journal` require **admin**; `anomaly` allows viewer.
**Journal:** enabled by default (`PEARDATA_JOURNAL=0` to disable). Linux only; installer adds `peardata` to `systemd-journal`.
**Journal:** enabled by default (`PEARDATA_JOURNAL=0` to disable). Linux only; installer adds `peardata` to `systemd-journal`. Omitted `source` defaults to **journal**.
Engine: `server/services/logs.js`. Unit tests: `test/logs.test.js`.
### Data Manager (read via settings)
`GET /api/v3/settings` includes `retention` and a `storage` summary (data dir / corestore / memory rings). Mutating retention / prune is **P2P admin RPC** (`setRetentionConfig`, `pruneHistory`) — see [PROTOCOL.md](./PROTOCOL.md) and [user-guide/settings.md](../user-guide/settings.md).
## CORS
`Access-Control-Allow-Origin` defaults to `*` (override with `PEARDATA_REST_CORS`).
@@ -190,7 +194,8 @@ Engine: `server/services/logs.js`. Unit tests: `test/logs.test.js`.
| Area | PearData |
|------|----------|
| Weights / Metric Correlations | `GET /api/v*/weights` — highlight-vs-baseline scoring (`method=volume\|ks2\|anomaly-rate\|value`) or alert weights when no window; see above |
| Logs | `GET /api/v*/logs` — anomaly / audit / journal; journal on by default; see above |
| Logs | `GET /api/v*/logs` — journal (default) / anomaly / audit; see above |
| Retention / storage | `GET /api/v*/settings` includes retention + usage; writes via P2P admin RPC |
| Multi-node parent streaming | Single node; parent planned |
| Cloud POST spaces APIs | Not implemented (agent GET style only) |
| App/plugin charts (nginx, DB, …) | System/OS charts; plugins later |