सीधे कंटेंट पर जाएँ
Localtonet Localtonet डैशबोर्ड

Localtonet REST API

इस पेज पर मदद पाएँ
इस पेज पर 8 सेक्शन
  1. इंटरैक्टिव रेफ़रेंस
  2. शुरू करने से पहले
  3. बेस URL और ऑथेंटिकेशन
  4. कन्वेंशन
  5. एरर
  6. रेट लिमिट
  7. उदाहरण
  8. अपने टनल सूचीबद्ध करें
  9. रैंडम सबडोमेन वाला HTTP टनल बनाएँ
  10. टनल शुरू करें
  11. एंडपॉइंट ग्रुप
  12. टनल
  13. बल्क टनल ऑपरेशन
  14. टनल कॉन्फ़िगरेशन
  15. AuthToken
  16. टोकन ग्रुप
  17. सर्वर
  18. SSO प्रोवाइडर
  19. VPN एक्सेस
  20. समस्या निवारण
  21. संबंधित पेज

REST API v2 टनल के लिए वही सब करता है जो डैशबोर्ड करता है: उन्हें बनाना, शुरू करना, रोकना, हटाना और कॉन्फ़िगर करना, और AuthToken, टोकन ग्रुप और SSO प्रोवाइडर मैनेज करना। आप हर रिक्वेस्ट को अपनी API कुंजी से ऑथेंटिकेट करते हैं।

इंटरैक्टिव रेफ़रेंस #

हर एंडपॉइंट, उसके रिक्वेस्ट और रिस्पॉन्स मॉडल और उसे आज़माने के फ़ॉर्म के साथ, इंटरैक्टिव रेफ़रेंस में है:

  • localtonet.com/api: API v2, मौजूदा वर्शन। आप डैशबोर्ड के API UI बटन से भी यहाँ पहुँच सकते हैं।
  • localtonet.com/api/v1: API v1, मौजूदा इंटीग्रेशन के लिए रखा गया। नए काम के लिए v2 इस्तेमाल करें।

यह पेज आपको कन्वेंशन और एंडपॉइंट ग्रुप की एक झलक देता है। रिक्वेस्ट के सटीक फ़ील्ड के लिए रेफ़रेंस में वह एंडपॉइंट खोलें।

शुरू करने से पहले #

  • आपकी API कुंजी। डैशबोर्ड खोलें और API कुंजी कार्ड में कॉपी करें इस्तेमाल करें। देखें अकाउंट और सुरक्षा।
  • टनल बनाने के लिए: उस डिवाइस का AuthToken जो टनल चलाएगा, और उसी टोकन से कनेक्टेड एक Localtonet क्लाइंट। देखें AuthToken।

अपनी API कुंजी निजी रखें। जिसके पास भी यह है, वह आपके टनल और टोकन बना, बदल और हटा सकता है। API कुंजी कार्ड में बदलें नई कुंजी बनाता है और पुरानी को अमान्य कर देता है।

बेस URL और ऑथेंटिकेशन #

सभी v2 एंडपॉइंट इससे शुरू होते हैं:

बेस URL
https://localtonet.com/api/v2

हर रिक्वेस्ट के Authorization हेडर में API कुंजी को Bearer टोकन के रूप में भेजें:

HTTP
GET /api/v2/tunnels HTTP/1.1
Host: localtonet.com
Authorization: Bearer <YOUR_API_KEY>

किसी टीम डैशबोर्ड में कॉपी की गई API कुंजी उस टीम के आपके AuthToken और टनल सूचीबद्ध करती है; आपके अपने अकाउंट की कुंजी वे AuthToken सूचीबद्ध करती है जो किसी टीम के नहीं हैं।

कन्वेंशन #

विषयAPI कैसे व्यवहार करती है
फ़ॉर्मैटरिक्वेस्ट और रिस्पॉन्स बॉडी JSON होती हैं। बॉडी के साथ Content-Type: application/json भेजें।
टनल IDपाथ में tunnelId टनल का संख्यात्मक id है, जैसा सूची और क्रिएट एंडपॉइंट लौटाते हैं।
पाथ में AuthToken{token} खुद AuthToken स्ट्रिंग है।
सफलता कोडरीड के लिए बॉडी के साथ 200, ज़्यादातर क्रिएट के लिए 201 (टनल क्रिएट एंडपॉइंट नया टनल लौटाते हैं), ज़्यादातर कार्रवाइयों और अपडेट के लिए बिना बॉडी के 204। रेफ़रेंस हर एंडपॉइंट का जवाब दिखाता है।
बल्क एंडपॉइंटजिन पाथ में /bulk/ है वे JSON ऐरे लेते हैं और हर रिक्वेस्ट में अधिकतम 100 आइटम स्वीकार करते हैं (/tunnels/bulk/protocol-type: अधिकतम 500)।
नए टनलआपका बनाया टनल अभी चल नहीं रहा होता। उसे स्टार्ट एक्शन से शुरू करें। सिर्फ़ proxy/with-detail एंडपॉइंट ही उसी कॉल में isStartAfterCreate से टनल शुरू कर सकते हैं।

एरर #

स्टेटसमतलबबॉडी
400रिक्वेस्ट बॉडी मान्य नहीं है, या ऑपरेशन अस्वीकार हुआ, जैसे आपके प्लान की किसी लिमिट की वजह से।ज़्यादातर एंडपॉइंट के लिए JSON में एक प्रॉब्लम ऑब्जेक्ट; title में संदेश होता है। वैलिडेशन एरर और बल्क एंडपॉइंट के एरर errors के अंतर्गत सूचीबद्ध होते हैं।
401API कुंजी गायब है या अमान्य है।कोई विशिष्ट संदेश नहीं
403, 409कुछ टनल कॉन्फ़िगरेशन और VPN एक्सेस एंडपॉइंट इसे तब लौटाते हैं जब बदलाव की अनुमति नहीं है या वह मौजूदा कॉन्फ़िगरेशन से टकराता है।एक प्रॉब्लम ऑब्जेक्ट, जिसके title में संदेश होता है।
404टनल या ऑब्जेक्ट नहीं मिला या आपका नहीं है।खाली या एक प्रॉब्लम ऑब्जेक्ट
429बहुत ज़्यादा रिक्वेस्ट।नीचे रेट लिमिट देखें।

रेट लिमिट #

रिक्वेस्ट पर रेट लिमिट लगी है। लिमिट से ज़्यादा की रिक्वेस्ट का जवाब 429 Too Many Requests होता है। थोड़ा रुकें और उसे फिर भेजें; कई अलग-अलग कॉल की जगह बल्क एंडपॉइंट इस्तेमाल करें।

उदाहरण #

<YOUR_API_KEY> की जगह अपनी API कुंजी और <YOUR_TOKEN> की जगह डिवाइस का AuthToken लगाएँ।

अपने टनल सूचीबद्ध करें #

Bash
curl https://localtonet.com/api/v2/tunnels \
  -H "Authorization: Bearer <YOUR_API_KEY>"

जवाब एक JSON ऐरे होता है, जिसमें हर टनल के लिए एक ऑब्जेक्ट होता है। उसके फ़ील्ड में id, title, url (पब्लिक एड्रेस), protocolType, authToken, serverId, clientIp और clientPort (लोकल टार्गेट), status और connectionStatus शामिल हैं। अगर अभी आपका कोई टनल नहीं है, तो खाली ऐरे की जगह जवाब 404 होता है।

रैंडम सबडोमेन वाला HTTP टनल बनाएँ #

पहले उस सर्वर का कोड लें जो आप इस्तेमाल करना चाहते हैं:

Bash
curl https://localtonet.com/api/v2/servers \
  -H "Authorization: Bearer <YOUR_API_KEY>"

हर एंट्री में एक serverCode, एक serverName और एक serverDomain होता है। फिर टनल बनाएँ। यह उदाहरण डिवाइस के पोर्ट 3000 पर चल रहे वेब ऐप को फ़ॉरवर्ड करता है:

Bash
curl -X POST https://localtonet.com/api/v2/tunnels/http/random-subdomain \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "authToken": "<YOUR_TOKEN>",
    "serverCode": "<SERVER_CODE>",
    "protocolType": 1,
    "ip": "127.0.0.1",
    "port": 3000
  }'
फ़ील्डमतलबमान
authTokenउस डिवाइस का AuthToken जो टनल चलाता है।ज़रूरी
serverCodeसर्वर, GET /servers से।ज़रूरी
protocolTypeटनल का टाइप।1 HTTP, 5 File Server, 24 MCP Gateway
ipवह लोकल IP एड्रेस जिस पर टनल फ़ॉरवर्ड करता है।एक मान्य IP एड्रेस, जैसे 127.0.0.1
portलोकल पोर्ट।1 से 65534
pathशेयर किया जाने वाला लोकल फ़ोल्डर।सिर्फ़ File Server के लिए ज़रूरी

जवाब नए टनल के साथ 201 Created होता है। उसका id और url नोट कर लें।

टनल शुरू करें #

Bash
curl -X POST https://localtonet.com/api/v2/tunnels/<TUNNEL_ID>/actions/start \
  -H "Authorization: Bearer <YOUR_API_KEY>"

जवाब 204 No Content होता है। डिवाइस का क्लाइंट कनेक्टेड होने पर टनल अपने url पर पहुँचने योग्य हो जाता है। उसे फिर रोकने के लिए /actions/stop इस्तेमाल करें।

एंडपॉइंट ग्रुप #

नीचे के सभी पाथ https://localtonet.com/api/v2 के सापेक्ष हैं।

टनल #

मेथडपाथउद्देश्य
GET/tunnelsआपके सभी टनल की सूची।
GET/tunnels/{tunnelId}एक टनल पाएँ।
POST/tunnels/http/random-subdomainरैंडम सबडोमेन के साथ HTTP, File Server या MCP Gateway टनल बनाएँ।
POST/tunnels/http/custom-subdomainअपनी चुनी हुई सबडोमेन के साथ एक बनाएँ।
POST/tunnels/http/custom-domainअपने डोमेन पर एक बनाएँ।
POST/tunnels/tcp-udpTCP, UDP या संयुक्त TCP और UDP टनल बनाएँ।
POST/tunnels/proxyHTTP, SOCKS5, Shadowsocks या VLESS प्रॉक्सी टनल बनाएँ।
POST/tunnels/proxy/with-detailप्रॉक्सी टनल बनाएँ और उसका पूरा कनेक्शन विवरण लौटाएँ।
POST/tunnels/shared-proxyशेयर्ड (रोटेटिंग) प्रॉक्सी टनल बनाएँ।
POST/tunnels/{tunnelId}/actions/startटनल शुरू करें।
POST/tunnels/{tunnelId}/actions/stopटनल रोकें।
DELETE/tunnels/{tunnelId}टनल को स्थायी रूप से हटाएँ।
PATCH/tunnels/{tunnelId}/titleशीर्षक बदलें।
PATCH/tunnels/{tunnelId}/local-ipलोकल IP एड्रेस बदलें।
PATCH/tunnels/{tunnelId}/local-portलोकल पोर्ट बदलें।
PATCH/tunnels/{tunnelId}/port-reservedTCP/UDP टनल का पोर्ट रिज़र्वेशन चालू या बंद करें।
PATCH/tunnels/{tunnelId}/legacy-connectलीगेसी कनेक्शन मोड चालू या बंद करें।
PATCH/tunnels/{tunnelId}/protocol-typeप्रॉक्सी टनल का प्रॉक्सी प्रोटोकॉल बदलें।
GET/tunnels/{tunnelId}/request-logsHTTP या File Server टनल के हाल के HTTP रिक्वेस्ट लॉग।

बल्क टनल ऑपरेशन #

मेथडपाथउद्देश्य
POST/tunnels/bulk/http/random-subdomainरैंडम सबडोमेन के साथ कई HTTP टनल बनाएँ।
POST/tunnels/bulk/http/custom-subdomainकस्टम सबडोमेन के साथ कई टनल बनाएँ।
POST/tunnels/bulk/http/custom-domainकस्टम डोमेन पर कई टनल बनाएँ।
POST/tunnels/bulk/tcp-udpकई TCP/UDP टनल बनाएँ।
POST/tunnels/bulk/proxyकई प्रॉक्सी टनल बनाएँ।
POST/tunnels/bulk/proxy/with-detailकई प्रॉक्सी टनल बनाएँ और उनका कनेक्शन विवरण लौटाएँ।
POST/tunnels/bulk/shared-proxyकई शेयर्ड (रोटेटिंग) प्रॉक्सी टनल बनाएँ।
POST/tunnels/bulk/actions/startकई टनल शुरू करें। बॉडी: टनल ID का ऐरे, जैसे [123, 456]।
POST/tunnels/bulk/actions/stopकई टनल रोकें। बॉडी: टनल ID का ऐरे।
DELETE/tunnels/bulkकई टनल हटाएँ। बॉडी: टनल ID का ऐरे।
PATCH/tunnels/bulk/protocol-typeकई प्रॉक्सी टनल का प्रॉक्सी प्रोटोकॉल बदलें।

टनल कॉन्फ़िगरेशन #

ये एंडपॉइंट एक टनल की सेटिंग्स बदलते हैं। ये सभी /tunnels/{tunnelId} से शुरू होते हैं। हर सेटिंग क्या करती है, यह सेटिंग्स रेफ़रेंस में बताया गया है।

मेथड/tunnels/{tunnelId} के बाद का पाथउद्देश्य
GET, POST, PATCH, DELETE/ip-restrictionsसभी IP प्रतिबंध सूचीबद्ध करें, जोड़ें, अनुमति या अस्वीकार मोड सेट करें, या हटाएँ। किसी एक को /ip-restrictions/{restrictionId} से हटाएँ।
GET, POST, PATCH, DELETE/access-controlsURL पाथ एक्सेस कंट्रोल के लिए वही। किसी एक को /access-controls/{controlId} से हटाएँ।
GET, PATCH/headersकस्टम HTTP हेडर।
GET, PATCH/authenticationHTTP बेसिक ऑथेंटिकेशन।
GET, PATCH/expirationटनल की समाप्ति तिथि।
GET, PATCH/server-portTCP/UDP टनल का सर्वर-साइड पोर्ट।
GET, PATCH/http-timeoutHTTP रिक्वेस्ट टाइमआउट।
GET, PATCH/rate-limitस्पीड लिमिट।
GET, PATCH/bandwidth-limitकुल डेटा ट्रांसफ़र लिमिट।
GET/bandwidth-usageमौजूदा बैंडविड्थ उपयोग। काउंटर को POST /bandwidth-usage/reset से रीसेट करें।
GET, PATCH/argumentsटनल के लिए कस्टम कमांड-लाइन आर्गुमेंट।
GET, POST/shared-proxy-clientsशेयर्ड (रोटेटिंग) प्रॉक्सी टनल के क्लाइंट सूचीबद्ध करें या जोड़ें। किसी एक को PATCH या DELETE /shared-proxy-clients/{clientId} से अपडेट या डिलीट करें।
GET/advanced-settingsटनल की सभी एडवांस्ड सेटिंग्स एक ही जवाब में।
GET, PATCH/ipv4-only, /wifi-split, /proxy-protocol, /pass-through, /https-only, /http3कोई एक एडवांस्ड सेटिंग पढ़ें या स्विच करें।
PATCH/ssl-streamSSL स्ट्रीम सेटिंग स्विच करें।
GET, PATCH/file-path, /host-header, /path-rewrite, /upstream-proxy, /note, /vlessकोई एक मान पढ़ें या बदलें।
GET, PUT/token-groupsटनल को असाइन किए गए टोकन ग्रुप।
GET, PATCH/serverटनल का सर्वर।

AuthToken #

मेथडपाथउद्देश्य
GET/auth-tokensआपके AuthToken की सूची।
GET/auth-tokens/detailविवरण के साथ आपके AuthToken की सूची।
GET/auth-tokens/{token}एक AuthToken का विवरण।
POST/auth-tokensAuthToken बनाएँ।
DELETE/auth-tokens/{token}AuthToken हटाएँ।
GET/auth-tokens/{token}/tunnelsAuthToken के टनल।
GET/auth-tokens/{token}/ip-historyडिवाइस के पब्लिक IP एड्रेस बदलाव का इतिहास।
GET, PATCH/auth-tokens/{token}/airplane-mode-settingsएयरप्लेन मोड ऑटोमेशन सेटिंग्स।
POST/auth-tokens/{token}/change-ip-links/{airplaneModeSettingId}Change IP लिंक जोड़ें।
DELETE/auth-tokens/{token}/change-ip-links/{id}Change IP लिंक हटाएँ।
POST/auth-tokens/{token}/restart-device-links/{airplaneModeSettingId}डिवाइस रीस्टार्ट लिंक जोड़ें।
DELETE/auth-tokens/{token}/restart-device-links/{id}डिवाइस रीस्टार्ट लिंक हटाएँ।
GET, PATCH/auth-tokens/{token}/argumentsAuthToken पर सेव किए गए क्लाइंट आर्गुमेंट।

टोकन ग्रुप #

मेथडपाथउद्देश्य
GET/token-groupsआपके टोकन ग्रुप की सूची।
GET/token-groups/{id}एक टोकन ग्रुप पाएँ।
POST/token-groupsटोकन ग्रुप बनाएँ।
DELETE/token-groups/{id}टोकन ग्रुप हटाएँ।
POST/token-groups/{id}/auth-tokensग्रुप में AuthToken जोड़ें।
DELETE/token-groups/{id}/auth-tokens/{tokenId}ग्रुप से AuthToken हटाएँ।

सर्वर #

मेथडपाथउद्देश्य
GET/serversवे सर्वर सूचीबद्ध करें जिन पर आप टनल बना सकते हैं, साथ में serverCode जो क्रिएट रिक्वेस्ट में इस्तेमाल होता है।

SSO प्रोवाइडर #

मेथडपाथउद्देश्य
GET/sso-providersआपके SSO प्रोवाइडर की सूची।
GET/sso-providers/default-endpointsSSO प्रोवाइडर टाइप के डिफ़ॉल्ट एंडपॉइंट।
POST/sso-providersSSO प्रोवाइडर बनाएँ या अपडेट करें।
DELETE/sso-providers/{id}SSO प्रोवाइडर हटाएँ।
GET/sso-providers/tunnel/{tunnelId}किसी टनल के लिए कॉन्फ़िगर किए SSO प्रोवाइडर। यहाँ tunnelId टनल का GUID (guidId) है।
PUT/sso-providers/tunnel/{tunnelId}किसी टनल के SSO प्रोवाइडर सेव करें।

प्रोवाइडर क्या करते हैं, यह जानने के लिए सिंगल साइन-ऑन देखें।

VPN एक्सेस #

VPN एक्सेस प्रॉक्सी टनल पर WireGuard या OpenVPN डिवाइस प्रोफ़ाइल देता है; उस डिवाइस का पूरा ट्रैफ़िक प्रॉक्सी से बाहर निकलता है। ये एंडपॉइंट /tunnels/{tunnelId}/vpn-access से शुरू होते हैं।

मेथड/tunnels/{tunnelId}/vpn-access के बाद का पाथउद्देश्य
GET(कोई नहीं)टनल के VPN डिवाइस सूचीबद्ध करें।
POST(कोई नहीं)VPN डिवाइस बनाएँ।
DELETE/{peerId}VPN डिवाइस हटाएँ (रद्द करें)।
POST/{peerId}/regenerateVPN डिवाइस की कुंजियाँ दोबारा बनाएँ।
GET/{peerId}/configVPN डिवाइस की कॉन्फ़िगरेशन फ़ाइल डाउनलोड करें।
GET/{peerId}/qrWireGuard डिवाइस कॉन्फ़िगरेशन का QR कोड।
GET/{peerId}/credentialsOpenVPN डिवाइस का यूज़रनेम और पासवर्ड।

समस्या निवारण #

हर रिक्वेस्ट 401 लौटाती है

हेडर जाँचें: यह Authorization: Bearer, फिर एक स्पेस और कुंजी होना चाहिए, कुंजी के आसपास कोट्स नहीं। अगर आपने API कुंजी कार्ड में बदलें चुना था, तो पुरानी कुंजी अब काम नहीं करती; नई कॉपी करें।

मुझे अपनी टीम के AuthToken नहीं दिखते

आप अपने अकाउंट की API कुंजी इस्तेमाल कर रहे हैं। टीम डैशबोर्ड पर जाएँ और वहीं से API कुंजी कॉपी करें।

टनल बन गया लेकिन उसका एड्रेस जवाब नहीं देता

नया टनल रुका हुआ होता है। POST /tunnels/{tunnelId}/actions/start कॉल करें, और जाँचें कि डिवाइस का Localtonet क्लाइंट उसी AuthToken से चल रहा है जो आपने इस्तेमाल किया।

मुझे 429 Too Many Requests मिलता है

रिक्वेस्ट पर रेट लिमिट लगी है। रुकें, फिर रिक्वेस्ट दोबारा भेजें, और अलग-अलग कॉल के लूप की जगह एक बल्क रिक्वेस्ट इस्तेमाल करें।

सपोर्ट