Remote Access
🛡️ Get the Remote Access status.
<h3>🛡️ Requires Capabilities: <code>ServerSettings.Read</code></h3>get/api/v1/connect/status
Response
enabledboolean required
Whether Remote Access is enabled on this server.
state'disconnected' | 'connecting' | 'connected' | 'auth_failed' required
Live state of the control channel to the Remote Access Server.
hostnamestring nullable required
The hostname assigned by the Remote Access Server, once registered.
signingKeyFingerprintstring nullable required
Truncated SHA-256 fingerprint of the probe signing key, for support diagnostics.
tokenExpiresAtstring nullable required
Expiry of the stored cloud credential, ISO 8601.
directEnabledboolean required
Whether clients may connect straight to this server.
relayEnabledboolean required
Whether clients may reach this server through Cardinal's metered relay.
publicPortnumber nullable required
The externally reachable port advertised to the Remote Access Server.
directUrlstring nullable required
The URL clients use to reach this server directly. Null until a hostname is assigned.
relayUrlstring nullable required
The URL clients use to reach this server through the relay.