🐚 Bash One-Liners

For sysadmins who prefer the terminal, you can interact with TunnelSats using standard curl, jq (1.6+) and wg (wireguard-tools).

1. Generate Your Keypair Locally

The private key stays on your machine; only its public half is sent.

2. Get a Lightning Invoice (registering your public key)

Generate a 1-month invoice for a specific region, bound to your key.

Create Subscription

3. Check Payment Status

Check Invoice Status & Polling by Payment Hash

4. Claim & Build Your Config

Once paid, claim with the same public key. The response contains the tunnel parameters only (fullConfig is null); your config is built locally from them and your private key. If the response is HTTP 202 ("status": "processing"), wait a few seconds and repeat the claim.

Claim WireGuard Configuration After Payment Settlement

5. Check Bandwidth & Expiry by WireGuard Key

Query real-time subscription status using your WireGuard public key (no auth needed).

6. Sync Subscription (Authenticated, Real-Time Refresh)

Force a real-time data sync from the VPN server. Requires an API key.

7. 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).

8. Auto-Renewal Cron Job

Add this script to your crontab to check expiry and generate a new invoice if needed.

9. Bandwidth Top-Up ($1 Usage Reset)

For the full bandwidth reset workflow, including a client-side usage policy and payment settlement, see ⚡ Bandwidth Top-Up ($1 Usage Reset).

1. Generate Your Keypair Locally#

2. Get a Lightning Invoice (registering your public key)#

3. Check Payment Status#

4. Claim & Build Your Config#

5. Check Bandwidth & Expiry by WireGuard Key#

6. Sync Subscription (Authenticated, Real-Time Refresh)#

7. List All Subscriptions (Snake Case Alert)#

8. Auto-Renewal Cron Job#

9. Bandwidth Top-Up ($1 Usage Reset)#