Copy Page
TunnelSats Public Wireguard API
Announcements
👋 About our team
💫 What is TunnelSats?
🚀 Introducing the TunnelSats Public API v1
🧩 How the TunnelSats StartOS Package Uses the Public API
How TunnelSats Leverages Public APIs for Confined VPN Management
🤖 Autonomous Agent Payments (L402 & x402) & Level 5 Agent-Native Architecture
📡 Discovery
List Available WireGuard Servers & Regions
GET
L402 Agent Payment Gateway Discovery Metadata
GET
⚡ Purchase
Create a New WireGuard Subscription (Invoice Generation)
Check Invoice Status & Polling by Payment Hash
Claim WireGuard Configuration After Payment Settlement
Autonomous Agent HTTP 402 Gateway (L402 Purchase + Claim)
🔄 Lifecycle
Get Subscription & Bandwidth Status by WireGuard Public Key
Sync Subscription (Real-Time Server Refresh)
Renew an Existing VPN Subscription (Anonymous)
Request Bandwidth Top-Up ($1 Usage Reset)
Check Region Switch Eligibility
Create or Reuse Region Switch Invoice
Claim Client-Held Region Switch Parameters
🔑 Account
List Account Subscriptions (Authenticated)
Create Referral Code
Get Referral Code
Referral History
🔧 Tools
Lightning Node Network Address Discovery
Universal Connectivity & Latency Probe
Cookbook
🛠️ Automation & Code Examples
🐚 Bash One-Liners
🚑 Node Health & Upkeep
⚡ Bandwidth Top-Up ($1 Usage Reset)
🛡️ Security & Authentication
🎁 Referral Program: Earn Bonus Months
🛑 Error Codes & Troubleshooting
🤖 Agent Payments: L402 & x402 Protocol
Schemas
Server
InvoiceOrder
SubscriptionStatus
NodeLookup
ConnectivityResult
ReferralHistory
ReferralCode
SubscriptionListItem
PublicKeyStatusResponse
BandwidthResetResponse
ApiError
ClaimResult
BandwidthResetPaymentStatus
RegionSwitchServer
RegionSwitchCheckResult
RenewalOrder
RegionSwitchInvoice
RegionSwitchClaimResult
RegionSwitchPaymentStatus
SyncResult
Sign-up
RegionSwitchServer
Copy Page
{
"id"
:
"string"
,
"domain"
:
"string"
,
"country"
:
"string"
,
"city"
:
"string"
,
"flag"
:
"string"
}