Skip to main content

RemoteAccessInfo

Aggregated remote access information for the local node.

Combines LAN and Tailscale access details into a single snapshot so operator apps can determine the best URL to reach this node and generate a bookmark or QR code.

Attributes: local: Direct LAN access details. tailscale: Tailscale overlay access details. preferred_url: Best URL for this node. Uses the Tailscale MagicDNS name when available (my-node.tailnet-abc.ts.net), falling back to the raw 100.x.x.x IP, then the LAN address. operator_url: preferred_url with /operator appended — suitable for QR code generation so mobile users land directly on the operator panel.

local objectrequired

Direct LAN access details.

ip objectrequired

Preferred LAN IPv4 address, or None if unknown.

anyOf
string
portPort (integer)required

API/dashboard port.

url objectrequired

http://{ip}:{port} if ip is known, else None.

anyOf
string
tailscale objectrequired

Tailscale overlay access details.

runningRunning (boolean)required

True when tailscaled is running and connected.

ip object

Tailscale IPv4 address (100.x.x.x).

anyOf
string
dnsName object

Fully-qualified Tailscale MagicDNS name.

anyOf
string
portPort (integer)required

API/dashboard port.

url object

http://{dns_name or ip}:{port} if running, else None. MagicDNS preferred.

anyOf
string
preferredUrl objectrequired

Best URL: Tailscale MagicDNS URL if available, else Tailscale IP URL, else local LAN URL.

anyOf
string
operatorUrl objectrequired

preferred_url + /operator. Suitable for QR code generation.

anyOf
string
RemoteAccessInfo
{
  "local": {
    "ip": "string",
    "port": 0,
    "url": "string"
  },
  "tailscale": {
    "running": true,
    "ip": "string",
    "dnsName": "string",
    "port": 0,
    "url": "string"
  },
  "preferredUrl": "string",
  "operatorUrl": "string"
}