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)
        POST
      • Check Invoice Status & Polling by Payment Hash
        GET
      • Claim WireGuard Configuration After Payment Settlement
        POST
      • Autonomous Agent HTTP 402 Gateway (L402 Purchase + Claim)
        POST
    • 🔄 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)
    • 🔑 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
      • ApiError
      • ClaimResult
      • BandwidthResetResponse
      • PublicKeyStatusResponse
      • SubscriptionListItem
      • ReferralCode
      • ReferralHistory
      • BandwidthResetPaymentStatus
      • RenewalOrder
      • SyncResult
    Tunnelsats Github
    Tunnelsats Telegram

    ClaimResult

    Legacy orders return config/fullConfig. Orders created with a wgPublicKey return only server, peer and vpnPort; config is absent and fullConfig is null.

    {
        "config": "[Interface]\nPrivateKey = ...\nAddress = 10.9.0.2/32\nDNS = 1.1.1.1\n\n[Peer]\nPublicKey = ...\nEndpoint = de2.tunnelsats.com:51820\nAllowedIPs = 0.0.0.0/0",
        "fullConfig": "string",
        "status": "success",
        "subscriptionEnd": "2027-01-01T00:00:00.000Z",
        "server": {
            "endpoint": "de2.tunnelsats.com:51820",
            "publicKey": "string",
            "allowedIPs": "0.0.0.0/0, ::/0"
        },
        "peer": {
            "address": "10.9.0.7",
            "publicKey": "string",
            "presharedKey": "string"
        },
        "vpnPort": 24556
    }
    Built with