vrr/Pulse
2
0
Fork 0
mirror of https://github.com/rcourtman/Pulse.git synced 2026-05-01 21:10:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Document WebSocket endpoints and mock-mode PUT method

Browse source 
- Add /ws and /api/agent/ws WebSocket endpoint documentation
- Add PUT method to mock-mode endpoint
This commit is contained in:
rcourtman 2026-02-01 22:26:17 +00:00
parent 80cdfab536
commit 017073a065
1 changed files with 29 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

29
docs/API.md
View file

@ -446,6 +446,7 @@ Legacy system settings endpoint (read-only).
### Toggle Mock Mode
`GET /api/system/mock-mode`
`POST /api/system/mock-mode`
`PUT /api/system/mock-mode`
Enable or disable mock data generation (dev/demo only).
### SSH Config (Temperature Monitoring)
@ -728,6 +729,10 @@ Unlinks a host agent from a node.
`DELETE /api/agents/host/{host_id}` (admin, `host-agent:manage`)
Removes a host agent from state.
### Host Agent Linking (Admin)
- `POST /api/agents/host/link` (admin, `host-agent:manage`)
- `POST /api/agents/host/unlink` (admin, `host-agent:manage`)
### Agent Remote Config
`GET /api/agents/host/{agent_id}/config`
Returns the server-side config payload for an agent (used by remote config and debugging). Requires `host-agent:config:read`.
@ -735,6 +740,23 @@ Returns the server-side config payload for an agent (used by remote config and d
`PATCH /api/agents/host/{agent_id}/config` (admin, `host-agent:manage`)
Updates server-side config for an agent (e.g., `commandsEnabled`).
### Docker Agent Management (Admin)
- `POST /api/agents/docker/commands/{commandId}/ack` (`docker:report`)
- `DELETE /api/agents/docker/hosts/{hostId}` (`docker:manage`, supports `?hide=true` or `?force=true`)
- `POST /api/agents/docker/hosts/{hostId}/allow-reenroll` (`docker:manage`)
- `PUT /api/agents/docker/hosts/{hostId}/unhide` (`docker:manage`)
- `PUT /api/agents/docker/hosts/{hostId}/pending-uninstall` (`docker:manage`)
- `PUT /api/agents/docker/hosts/{hostId}/display-name` (`docker:manage`)
- `POST /api/agents/docker/hosts/{hostId}/check-updates` (`docker:manage`)
- `POST /api/agents/docker/containers/update` (`docker:manage`)
### Kubernetes Agent Management (Admin)
- `DELETE /api/agents/kubernetes/clusters/{clusterId}` (`kubernetes:manage`, supports `?hide=true` or `?force=true`)
- `POST /api/agents/kubernetes/clusters/{clusterId}/allow-reenroll` (`kubernetes:manage`)
- `PUT /api/agents/kubernetes/clusters/{clusterId}/unhide` (`kubernetes:manage`)
- `PUT /api/agents/kubernetes/clusters/{clusterId}/pending-uninstall` (`kubernetes:manage`)
- `PUT /api/agents/kubernetes/clusters/{clusterId}/display-name` (`kubernetes:manage`)
### Agent Profiles (Pro)
`GET /api/admin/profiles` (admin, Pro)
`POST /api/admin/profiles` (admin, Pro)
@ -755,4 +777,11 @@ Updates server-side config for an agent (e.g., `commandsEnabled`).
---
## 🔌 WebSocket Endpoints
- `GET /ws` – Primary UI WebSocket (browser sessions).
- `GET /api/agent/ws` – Agent WebSocket used for AI command execution.
---
> **Note**: This is a summary of the most common endpoints. For a complete list, inspect the network traffic of the Pulse dashboard or check the source code in `internal/api/router.go`.