Skip to main content

Gluetun

@kitquiet/gluetunv2026.07.23.1· 1mo agoMODELS
01README

Read-only VPN status and public IP visibility for gluetun's HTTP control server, using the protocol-agnostic status endpoint (not the OpenVPN-specific one, which misreports on WireGuard setups). API key resolved from a vault at execution time.

02Models1
@kitquiet/gluetunv2026.07.23.1gluetun.ts

Global Arguments

ArgumentTypeDescription
baseUrlstringGluetun control server base URL, e.g. http://localhost:8001. Not
apiKeystringGluetun control server API key (X-Api-Key header). Requires a
fn get_vpn_status()
Fetch gluetun's protocol-agnostic VPN status (not the OpenVPN-specific endpoint, which misreports on WireGuard setups)
fn get_public_ip()
Fetch the public IP address as seen through the VPN tunnel

Resources

vpn_status(1h)— Gluetun's protocol-agnostic VPN connection status
public_ip(1h)— The public IP address as seen through the VPN tunnel
03Stats
A
100 / 100
Downloads
0
Archive size
6.0 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository2/2earned
04Platforms