Cookbook
Copy Page
TunnelSats Public Wireguard API
About our team
📢 Public
List available VPN servers
GET
Create a new VPN subscription
POST
Claim a WireGuard configuration after payment
POST
Check subscription status via payment hash
GET
Renew an existing VPN subscription
POST
Get Subscription Status
POST
🔐 Authenticated
Sync Subscription
POST
Create Referral Code
POST
Referral History
GET
List all active/paid subscriptions for the account
GET
🔧 Tools
Lightning Node Network Address Discovery
POST
Universal Connectivity Probe
POST
Announcements
💫 What is TunnelSats?
🚀 Introducing the TunnelSats Public API v1
How TunnelSats Leverages Public APIs for Confined VPN Management
Cookbook
🛠️ Automation & Code Examples
🐚 Bash One-Liners
🛑 Error Codes & Troubleshooting
🎁 Referral Program: Earn Bonus Months
🚑 Node Health & Upkeep
🛡️ Security & Authentication
Schemas
Server
InvoiceOrder
SubscriptionStatus
WireGuardConfig
ReferralCode
ReferralHistory
NodeLookup
ConnectivityResult
RenewalOrder
ClaimResult
ApiError
SubscriptionListItem
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 (Dual-Key Support)
#
Once paid, run this to save your WireGuard config. Note that we handle both
.fullConfig
and
.config
keys to ensure compatibility.
Claim Subscription
4. List All Subscriptions (Snake Case Alert)
#
When listing all subscriptions for an authenticated account, the API returns
snake_case
keys (e.g.,
payment_hash
instead of
paymentHash
).
5. Auto-Renewal Cron Job
#
Add this script to your crontab to check expiry and generate a new invoice if needed.
Modified at
2026-04-12 13:24:01
Previous
🛠️ Automation & Code Examples
Next
🛑 Error Codes & Troubleshooting