System

The system surface exposes server-side diagnostics: host info, uptime, active connections, version, the WebSocket entry point, and the deployment's helper/monitor portal URLs. All read-only.

Quick reference

Method	What it does
client.system.host()	Hostname + status snapshot.
client.system.uptime()	Per-service uptime rows.
client.system.connections()	Currently active connections.
client.system.health()	Aggregated SystemHealth (host + uptime + connections in one call).
client.system.version()	Server version metadata (GET /version — outside the /api/v2/ prefix).
client.system.beta_version()	Beta-channel version.
client.system.ws_host()	The WebSocket host clients should dial (REST hop before WS).
client.system.helper_link()	URL of the deployment's help portal (or None).
client.system.monitor_link()	URL of the deployment's site-monitor portal (or None).

Aggregate health

health() runs host + uptime + connections sequentially and folds them into one SystemHealth snapshot. A failure on any sub-call sets that field to None and records the exception in .errors, leaving the rest of the snapshot intact:

h = client.system.health()
print(h.host, len(h.connections), h.partial, h.errors)

SystemHealth.partial is True when at least one sub-call failed.

Model — SystemHealth

Field	Type	Notes
host	Host \| None	Hostname snapshot.
uptime	list[Uptime]	Per-service uptime rows.
connections	list[Connection]	Active connections.
partial	bool	True if any sub-call failed.
errors	dict[str, Exception]	Per-sub-call failure.

Host, Uptime, Connection, Version, WsHost are sibling models — see the API reference for the full fields.

Related entities

• Context: client.context.load() calls system.health() as one of its sub-fetches.

See also

• Error handling — .partial / .errors is the same shape as SessionContext.