WebSocket Endpoints

Real-time streaming endpoints for logs, metrics, terminal access, and notifications.

Authentication

WebSocket connections authenticate via a token query parameter:


wss://plane.lnchr.cloud/<tenant>/ws/applications/:id/logs?token=<jwt>

Endpoints

Endpoint	Description
`/ws/deployments/:id/logs`	Live deployment build logs
`/ws/applications/:id/logs`	Live application runtime logs
`/ws/applications/:id/traffic`	Live application traffic metrics
`/ws/databases/:id/logs`	Live database logs
`/ws/servers/:id/metrics`	Live server metrics (CPU, memory, disk)
`/ws/terminal/:sessionId`	Interactive terminal session
`/ws/notifications`	Real-time in-app notifications
`/ws/logs`	Unified log stream (multi-resource)

Usage Example


const ws = new WebSocket(
  'wss://plane.lnchr.cloud/<tenant>/ws/applications/<id>/logs?token=<jwt>'
);
 
ws.onmessage = (event) => {
  const log = JSON.parse(event.data);
  console.log(log.message);
};

Terminal Sessions

To use the interactive terminal:

Create a session via the REST API:


POST /api/v1/applications/:id/terminal
POST /api/v1/databases/:id/terminal
POST /api/v1/servers/:id/terminal

Connect to the WebSocket using the returned sessionId:
```
/ws/terminal/:sessionId
```

Terminal sessions support full PTY with resize events.