Skip to main content

WebSocket API Reference

Real-time communication and monitoring through WebSocket connections. The WebSocket API provides live updates for deployments, metrics, and logs.

Endpoints Overview

WebSocket Connection

Establishing Connection

Connect to the WebSocket endpoint:

Message Types

Deployment Messages

Log Messages

Metrics Messages

Status Messages

Subscription Management

Subscribe to Deployment

Subscribe to Logs

Subscribe to Metrics

Unsubscribe

API Endpoints

Get WebSocket Statistics

Response:

Get Performance Metrics

Response:

Check WebSocket Health

Response:

Error Handling

Connection Errors

Subscription Errors

Rate Limiting

Best Practices

Connection Management

  • Implement connection retry logic with exponential backoff
  • Handle connection drops gracefully
  • Monitor connection health and reestablish when needed
  • Use appropriate heartbeat intervals

Message Handling

  • Process messages asynchronously to avoid blocking
  • Implement message buffering for high-volume streams
  • Handle message ordering and deduplication
  • Monitor message processing performance

Error Recovery

  • Implement automatic reconnection on connection loss
  • Handle subscription failures gracefully
  • Monitor error rates and patterns
  • Implement circuit breaker patterns

Performance Optimization

  • Use appropriate message compression
  • Implement batching for high-frequency updates
  • Monitor WebSocket performance metrics
  • Optimize message serialization/deserialization

Integration Examples

Real-time Deployment Dashboard

Live Metrics Display

For detailed schema definitions, refer to the OpenAPI specification published alongside the backend service.