Sign in
Remote Access

🛡️ Enable Remote Access.

Issues a Remote Access credential from Cardinal Cloud for this server and opens the control channel. Requires the cloud account JWT header.<br /><hr /><h3>🛡️ Requires Capabilities: <code>ServerSettings.Update</code></h3>

post/api/v1/connect/enable

Headers

CardinalTolkienstring

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.

Changes