1. 🔄 Lifecycle
TunnelSats Public Wireguard API
  • Announcements
    • 👋 About our team
    • 💫 What is TunnelSats?
    • 🚀 Introducing the TunnelSats Public API v1
    • How TunnelSats Leverages Public APIs for Confined VPN Management
  • 📡 Discovery
    • List Available WireGuard Servers & Regions
      GET
  • ⚡ Purchase
    • Create a New WireGuard Subscription (Invoice Generation)
      POST
    • Check Invoice Status & Polling by Payment Hash
      GET
    • Claim WireGuard Configuration After Payment Settlement
      POST
  • 🔄 Lifecycle
    • Get Subscription & Bandwidth Status by WireGuard Public Key
      POST
    • Renew an Existing VPN Subscription (Anonymous)
      POST
    • Sync Subscription (Real-Time Server Refresh)
      POST
    • Request Bandwidth Top-Up ($1 for +100GB)
      POST
  • 🔑 Account
    • List Account Subscriptions (Authenticated)
      GET
  • 🔧 Tools
    • Lightning Node Network Address Discovery
      POST
    • Universal Connectivity & Latency Probe
      POST
  • Cookbook
    • 🛠️ Automation & Code Examples
    • 🐚 Bash One-Liners
    • 🚑 Node Health & Upkeep
    • ⚡ Bandwidth Top-Up ($1 for +100GB)
    • 🛡️ Security & Authentication
    • 🎁 Referral Program: Earn Bonus Months
    • 🛑 Error Codes & Troubleshooting
  • Schemas
    • Server
    • InvoiceOrder
    • SubscriptionStatus
    • NodeLookup
    • ConnectivityResult
    • ApiError
    • ClaimResult
    • BandwidthResetResponse
    • PublicKeyStatusResponse
    • RenewalOrder
    • SubscriptionListItem
    • SyncResult
Tunnelsats Github
Tunnelsats Telegram
  1. 🔄 Lifecycle

Request Bandwidth Top-Up ($1 for +100GB)

POST
https://tunnelsats.com/api/public/v1/subscription/bandwidth-reset
Generates a $1 USD Lightning invoice to instantly reset bandwidth consumption to 0MB (+100GB allowance) and re-enable a throttled/disabled WireGuard peer. Usage must exceed 70% threshold. Rate limit: 10 requests/min per IP. Monthly limit: 2 confirmed resets per key.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK
application/json
Bandwidth reset invoice generated
Bodyapplication/json

🟠400Bad Request
🟠404Record Not Found
🟠429OK
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://tunnelsats.com/api/public/v1/subscription/bandwidth-reset' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--data '{
    "wgPublicKey": "pWyZTQx8C4gzzgMVJHiN1ptI46wDtyJSMRa+wxtkXOM=",
    "serverId": "us-east"
}'
Response Response Example
200 - Success Example
{
    "invoice": "lnbc30000n1p...",
    "paymentHash": "c3d4e5f6a1b2...",
    "resetId": "d7b2277f-5990-4721-a565-6816babadc59",
    "amountSats": 3000,
    "amountUsd": "1.00",
    "currentUsagePercent": "85.4",
    "resetsThisMonth": 0,
    "maxResetsPerMonth": 2
}
Modified at 2026-09-02 16:36:08
Previous
Sync Subscription (Real-Time Server Refresh)
Next
List Account Subscriptions (Authenticated)
Built with