v1

latestOpenAPI 3.1.02026-07-22100167210.7 KB
Replica

Stream Events

Opens a Server-Sent Events (SSE) stream for real-time events from a replica. The connection remains open and events are pushed as they occur.

Each event is delivered as an SSE message in the format data: <JSON>\n\n. A heartbeat ping is sent every 15 seconds to keep the connection alive. Clients should reconnect automatically on disconnect.

All events share a common envelope structure with id (unique event ID), ts (ISO 8601 timestamp), type (event type discriminator), and payload (type-specific data). See the EngineEvent schema for all possible event types.

get/v1/replica/{id}/events

Path parameters

idstring uuid required

The unique identifier of the replica

Response

SSE event stream opened successfully. Each line is a JSON-encoded EngineEvent.