Live Telemetry
Stream live metrics events (Enterprise)
Changed onOpens a text/event-stream connection streaming server metrics in real time. Requires LiveMetrics permission; may be authenticated via the ?token= query parameter from /api/token/metrics. Enterprise only.
get/api/live/metrics
Request
- Base URLhttps://mail.example.com
- Auth
- HTTP bearer
- or HTTP basic
- or API key in query parameter token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Response
Server-Sent Events stream of metric events
Changes
- info
endpoint added
- info
- breaking
api path removed without deprecation
- breaking