system

Get tunnel service status

Changed on

Returns status information about the tunnel service (Tailscale). Developer, manager, or admin only.

get/services/tunnel

Request

  • Base URL
    http://localhost/api/v1
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or none

Query parameters

remoteNodestring

name of the remote node

Response

A successful response

enabledboolean required

Whether tunneling is enabled in configuration

provider'tailscale'

The tunnel provider in use

status'disabled' | 'connecting' | 'connected' | 'reconnecting' | 'error' required

Current status of the tunnel

publicUrlstring uri

The public URL provided by the tunnel

errorstring

Error message if tunnel failed

startedAtstring date-time

RFC3339 timestamp when tunnel connected

modestring

Tunnel mode (e.g., 'direct' or 'funnel' for Tailscale)

isPublicboolean

Whether the tunnel provides public internet access

Changes

    • warning

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

    • warning

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

    • warning

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

    • warning

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