CAcardinalapps
Remote Access

🛡️ Enable Remote Access.

Changed on

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

Request

Headers

CardinalTolkienstring

Response

enabledboolean required

Whether Remote Access is enabled on this server.

state'disconnected' | 'connecting' | 'connected' | 'auth_failed' | 'not_approved' | 'suspended' required

Live state of the control channel to the Remote Access Server. not_approved means the cloud account is waiting on service access for a Remote Access feature, and suspended means the account is suspended; both retry on their own.

hostnamestring nullable required

The hostname assigned by the Remote Access Server, once registered.

vanityHostnamestring nullable required

The owner-chosen vanity hostname, once the certificate covers it. Preferred over hostname when set.

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.

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

  • 8bcf1f05a7f7Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 4e6c4e963749Revision changes
    • warning

      added the new not_approved enum value to the response property for the response status

    • warning

      added the new not_approved enum value to the response property for the response status

    • warning

      added the new suspended enum value to the response property for the response status

    • warning

      added the new suspended enum value to the response property for the response status