Sign in
Remote Access

🛡️ Disable Remote Access.

Closes the control channel and disables Remote Access. When the cloud account JWT header is present, the Remote Access credential is also revoked with Cardinal Cloud.<br /><hr /><h3>🛡️ Requires Capabilities: <code>ServerSettings.Update</code></h3>

post/api/v1/connect/disable

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

Changed in 5 of the 176 revisions of this API.4415

  • 8bcf1f05a7f72See the full diff
    • ○

      added the required property vanityHostname to the response with the 200 status

      response-required-property-added

    • ○

      added the required property vanityHostname to the response with the 201 status

      response-required-property-added

  • 4e6c4e9637494See the full diff
    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

  • 5b4d68eba1df4See the full diff
    • ▲

      removed the required property directEnabled from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property directEnabled from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property relayEnabled from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property relayEnabled from the response with the 201 status

      response-required-property-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c3d02ccf700412See the full diff
    • ○

      added the required property directEnabled to the response with the 200 status

      response-required-property-added

    • ○

      added the required property directEnabled to the response with the 201 status

      response-required-property-added

    • ○

      added the required property directUrl to the response with the 200 status

      response-required-property-added

    • ○

      added the required property directUrl to the response with the 201 status

      response-required-property-added

    • ○

      added the required property https to the response with the 200 status

      response-required-property-added

    • ○

      added the required property https to the response with the 201 status

      response-required-property-added

    • ○

      added the required property publicPort to the response with the 200 status

      response-required-property-added

    • ○

      added the required property publicPort to the response with the 201 status

      response-required-property-added

    • ○

      added the required property relayEnabled to the response with the 200 status

      response-required-property-added

    • ○

      added the required property relayEnabled to the response with the 201 status

      response-required-property-added

    • ○

      added the required property relayUrl to the response with the 200 status

      response-required-property-added

    • ○

      added the required property relayUrl to the response with the 201 status

      response-required-property-added

  • eca025445dda1See the full diff
    • ○

      endpoint added

      endpoint-added