TunnelSats Public Wireguard API
Cookbook
Copy Page
TunnelSats Public Wireguard API
About our team
📢 Public
List Servers
GET
Create Subscription
POST
Check Status / Heal
GET
Claim Subscription
POST
Renew Subscription
POST
Get Subscription Status
POST
🔐 Authenticated
List My Subscriptions
GET
Sync Subscription
POST
Create Referral Code
POST
Referral History
GET
Announcements
💫 What is TunnelSats?
🚀 Introducing the TunnelSats Public API v1
Cookbook
🛠️ Automation & Code Examples
🐚 Bash One-Liners
🛑 Error Codes & Troubleshooting
🎁 Referral Program: Earn Bonus Months
Schemas
Server
InvoiceOrder
SubscriptionStatus
WireGuardConfig
ReferralCode
ReferralHistory
NodeLookup
ConnectivityResult
Cookbook
Copy Page
🐚 Bash One-Liners
For sysadmins who prefer the terminal, you can interact with TunnelSats using standard
curl
and
jq
.
1. Get a Lightning Invoice
#
Generate a 1-month invoice for a specific region directly to your console.
Create Subscription
2. Check Payment Status
#
Replace
<payment_hash>
with the hash returned from the previous step.
Check Status / Heal
3. Claim & Save Config
#
Once paid, run this to save your WireGuard config to a file named
tunnelsatsv2.conf
.
Claim Subscription
4. Auto-Renewal Cron Job
#
Add this script to your crontab to check expiry and generate a new invoice if needed.
Modified at
2026-02-12 22:13:45
Previous
🛠️ Automation & Code Examples
Next
🛑 Error Codes & Troubleshooting