---
title: "🛡️ Get the Remote Access status."
method: GET
path: "/api/v1/connect/status"
tags: ["Remote Access"]
---

# 🛡️ Get the Remote Access status.

`GET /api/v1/connect/status`

<h3>🛡️ Requires Capabilities: <code>ServerSettings.Read</code></h3>

## Response `200`

- ConnectStatusResponse
  - `enabled` boolean, 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.
  - `hostname` string, nullable, required — The hostname assigned by the Remote Access Server, once registered.
  - `vanityHostname` string, nullable, required — The owner-chosen vanity hostname, once the certificate covers it. Preferred over `hostname` when set.
  - `signingKeyFingerprint` string, nullable, required — Truncated SHA-256 fingerprint of the probe signing key, for support diagnostics.
  - `tokenExpiresAt` string, nullable, required — Expiry of the stored cloud credential, ISO 8601.
  - `publicPort` number, nullable, required — The externally reachable port advertised to the Remote Access Server.
  - `directUrl` string, nullable, required — The URL clients use to reach this server directly. Null until a hostname is assigned.
  - `relayUrl` string, nullable, required — The URL clients use to reach this server through the relay.
  - `https` ConnectHttpsStatus, required
    - `state` 'stopped' | 'running' | 'error', required — State of the Remote Access HTTPS listener, which serves direct connections.
    - `port` number, nullable, required — The port the listener is bound to, once running.
    - `certExpiresAt` string, nullable, required — Expiry of the TLS certificate in use, ISO 8601.
    - `lastError` string, nullable, required — Why the listener could not start or why cert material was rejected.

## Other responses

- `401` — Possible reasons: The authorization token is invalid.
- `403` — Possible reasons: The user does not have sufficent capabilities.

## Changes

- **2026-08-21** `8bcf1f05a7f7` — 1 info
  - added the required property `vanityHostname` to the response with the `200` status
- **2026-08-16** `4e6c4e963749` — 2 warning
  - added the new `not_approved` enum value to the `state` response property for the response status `200`
  - added the new `suspended` enum value to the `state` response property for the response status `200`
- **2026-08-14** `5b4d68eba1df` — 2 breaking
  - removed the required property `directEnabled` from the response with the `200` status
  - removed the required property `relayEnabled` from the response with the `200` status
- **2026-08-14** `c3d02ccf7004` — 6 info
  - added the required property `directEnabled` to the response with the `200` status
  - added the required property `directUrl` to the response with the `200` status
  - added the required property `https` to the response with the `200` status
  - added the required property `publicPort` to the response with the `200` status
  - …2 more
- **2026-08-07** `eca025445dda` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/cardinalapps/apis/cardinal-media-server-api/changes/api/v1/connect/status/get.md)

---

[API](https://skmtc.dev/cardinalapps/apis/cardinal-media-server-api.md) · [All operations](https://skmtc.dev/cardinalapps/apis/cardinal-media-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cardinalapps/cardinal-media-server-api/revisions/7b5e4555e84f/schema)
