Sign in
Remote Access

🛡️ Update the Remote Access connection paths.

Enables or disables direct and relayed connections independently. Both are on while Remote Access is enabled unless turned off here.<br /><hr /><h3>🛡️ Requires Capabilities: <code>ServerSettings.Update</code></h3>

put/api/v1/connect/settings

Request body

directEnabledboolean

Whether clients may connect straight to this server. Turning it off stops the Remote Access HTTPS listener.

relayEnabledboolean

Whether clients may reach this server through Cardinal's metered relay.

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.

Changes