İçeriğe geç
Localtonet Localtonet Panel

Localtonet REST API

Bu sayfa için yardım al
Bu sayfada 8 bölüm
  1. Etkileşimli başvuru
  2. Başlamadan önce
  3. Temel URL ve kimlik doğrulama
  4. Kurallar
  5. Hatalar
  6. Hız sınırları
  7. Örnekler
  8. Tünellerinizi listeleme
  9. Rastgele alt alan adıyla HTTP tüneli oluşturma
  10. Tüneli başlatın
  11. Uç nokta grupları
  12. Tüneller
  13. Toplu tünel işlemleri
  14. Tünel yapılandırması
  15. AuthToken'lar
  16. Token grupları
  17. Sunucular
  18. SSO sağlayıcıları
  19. VPN erişimi
  20. Sorun giderme
  21. İlgili sayfalar

REST API v2, tüneller için panelin yaptığı işleri yapar: tünel oluşturma, başlatma, durdurma, silme ve yapılandırma; ayrıca AuthToken'ları, token gruplarını ve SSO sağlayıcılarını yönetme. Her isteği API anahtarınızla doğrularsınız.

Etkileşimli başvuru #

Tüm uç noktalar, istek ve yanıt modelleriyle ve denemek için bir formla birlikte etkileşimli başvuruda yer alır:

  • localtonet.com/api: API v2, güncel sürüm. Ona panelde API Arayüzü düğmesiyle de ulaşırsınız.
  • localtonet.com/api/v1: API v1, mevcut entegrasyonlar için korunur. Yeni işlerde v2'yi kullanın.

Bu sayfa size kuralları ve uç nokta gruplarına genel bir bakış sunar. Bir isteğin tam alanları için uç noktayı başvuruda açın.

Başlamadan önce #

  • API anahtarınız. Panel'i açın ve API Anahtarı kartındaki Kopyala düğmesini kullanın. Hesap ve güvenlik sayfasına bakın.
  • Tünel oluşturmak için: tüneli çalıştıracak cihazın bir AuthToken'ı ve o token ile bağlı bir Localtonet istemcisi. AuthToken'lar sayfasına bakın.

API anahtarınızı gizli tutun. Ona sahip olan herkes tünellerinizi ve token'larınızı oluşturabilir, değiştirebilir ve silebilir. API Anahtarı kartındaki Değiştir düğmesi yeni bir anahtar oluşturur ve eskisini geçersiz kılar.

Temel URL ve kimlik doğrulama #

Tüm v2 uç noktaları şununla başlar:

Temel URL
https://localtonet.com/api/v2

API anahtarını her isteğin Authorization başlığında Bearer token olarak gönderin:

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

Bir ekip panelinde kopyalanan API anahtarı, o ekipteki AuthToken'larınızı ve tünellerinizi listeler; kendi hesabınızın anahtarı ise hiçbir ekibe ait olmayan AuthToken'ları listeler.

Kurallar #

KonuAPI nasıl davranır
Biçimİstek ve yanıt gövdeleri JSON'dır. Gövde gönderirken Content-Type: application/json gönderin.
Tünel kimliğiYoldaki tunnelId, liste ve oluşturma uç noktalarının döndürdüğü tünelin sayısal id değeridir.
Yoldaki AuthToken{token}, AuthToken dizesinin kendisidir.
Başarı kodlarıOkumalar için gövdeli 200, çoğu oluşturma için 201 (tünel oluşturma uç noktaları yeni tüneli döndürür), çoğu eylem ve güncelleme için gövdesiz 204. Başvuru her uç noktanın yanıtını gösterir.
Toplu uç noktalar/bulk/ içeren yollar bir JSON dizisi alır ve istek başına en fazla 100 öğe kabul eder (/tunnels/bulk/protocol-type: en fazla 500).
Yeni tünellerOluşturduğunuz tünel henüz çalışmaz. Onu başlatma eylemiyle başlatın. Yalnızca proxy/with-detail uç noktaları tüneli aynı çağrıda isStartAfterCreate ile başlatabilir.

Hatalar #

DurumAnlamıGövde
400İstek gövdesi geçerli değil veya işlem reddedildi; örneğin planınızın bir limiti nedeniyle.Çoğu uç noktada JSON biçiminde bir sorun nesnesi; title iletiyi içerir. Doğrulama hataları ve toplu uç noktaların hataları errors altında listelenir.
401API anahtarı eksik veya geçersiz.Belirli bir ileti yok
403, 409Değişikliğe izin verilmediğinde veya mevcut yapılandırmayla çakıştığında bazı tünel yapılandırma ve VPN erişimi uç noktaları tarafından döndürülür.İletinin title içinde olduğu bir sorun nesnesi.
404Tünel veya nesne bulunamadı ya da size ait değil.Boş veya bir sorun nesnesi
429Çok fazla istek.Aşağıdaki hız sınırlarına bakın.

Hız sınırları #

İstekler hız sınırına tabidir. Sınırı aşan bir isteğe 429 Too Many Requests ile yanıt verilir. Bekleyin ve yeniden gönderin; çok sayıda tekli çağrı yerine toplu uç noktaları kullanın.

Örnekler #

<YOUR_API_KEY> yerine API anahtarınızı, <YOUR_TOKEN> yerine cihazın AuthToken'ını yazın.

Tünellerinizi listeleme #

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

Yanıt, her tünel için bir nesne içeren bir JSON dizisidir. Alanları arasında id, title, url (herkese açık adres), protocolType, authToken, serverId, clientIp ve clientPort (yerel hedef), status ve connectionStatus bulunur. Henüz hiç tünel oluşturmadıysanız yanıt boş bir dizi yerine 404 olur.

Rastgele alt alan adıyla HTTP tüneli oluşturma #

Önce kullanmak istediğiniz sunucunun kodunu alın:

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

Her girişte bir serverCode, bir serverName ve bir serverDomain vardır. Ardından tüneli oluşturun. Bu örnek, cihazın 3000 portundaki bir web uygulamasına yönlendirir:

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
  }'
AlanAnlamıDeğerler
authTokenTüneli çalıştıran cihazın AuthToken'ı.Zorunlu
serverCodeSunucu, GET /servers çıktısından.Zorunlu
protocolTypeTünel türü.1 HTTP, 5 File Server, 24 MCP Gateway
ipTünelin yönlendirdiği yerel IP adresi.Geçerli bir IP adresi, örneğin 127.0.0.1
portYerel port.1 ile 65534 arası
pathPaylaşılacak yerel klasör.Yalnızca File Server için zorunlu

Yanıt, yeni tünelle birlikte 201 Created olur. id ve url değerlerini not alın.

Tüneli başlatın #

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

Yanıt 204 No Content olur. Cihazın istemcisi bağlı olduğunda tünele url adresinden ulaşılabilir. Tekrar durdurmak için /actions/stop kullanın.

Uç nokta grupları #

Aşağıdaki tüm yollar https://localtonet.com/api/v2 adresine görecelidir.

Tüneller #

YöntemYolAmaç
GET/tunnelsTüm tünellerinizi listeler.
GET/tunnels/{tunnelId}Tek bir tüneli getirir.
POST/tunnels/http/random-subdomainRastgele alt alan adıyla bir HTTP, File Server veya MCP Gateway tüneli oluşturur.
POST/tunnels/http/custom-subdomainSeçtiğiniz bir alt alan adıyla tünel oluşturur.
POST/tunnels/http/custom-domainKendi alan adınızda tünel oluşturur.
POST/tunnels/tcp-udpBir TCP, UDP veya birleşik TCP ve UDP tüneli oluşturur.
POST/tunnels/proxyBir HTTP, SOCKS5, Shadowsocks veya VLESS proxy tüneli oluşturur.
POST/tunnels/proxy/with-detailBir proxy tüneli oluşturur ve tüm bağlantı ayrıntılarını döndürür.
POST/tunnels/shared-proxyPaylaşılan (rotasyonlu) bir proxy tüneli oluşturur.
POST/tunnels/{tunnelId}/actions/startBir tüneli başlatır.
POST/tunnels/{tunnelId}/actions/stopBir tüneli durdurur.
DELETE/tunnels/{tunnelId}Bir tüneli kalıcı olarak siler.
PATCH/tunnels/{tunnelId}/titleBaşlığı değiştirir.
PATCH/tunnels/{tunnelId}/local-ipYerel IP adresini değiştirir.
PATCH/tunnels/{tunnelId}/local-portYerel portu değiştirir.
PATCH/tunnels/{tunnelId}/port-reservedBir TCP/UDP tünelinin port rezervasyonunu açar veya kapatır.
PATCH/tunnels/{tunnelId}/legacy-connectEski bağlantı modunu açar veya kapatır.
PATCH/tunnels/{tunnelId}/protocol-typeBir proxy tünelinin proxy protokolünü değiştirir.
GET/tunnels/{tunnelId}/request-logsBir HTTP veya File Server tünelinin son HTTP istek günlükleri.

Toplu tünel işlemleri #

YöntemYolAmaç
POST/tunnels/bulk/http/random-subdomainRastgele alt alan adlarıyla birden fazla HTTP tüneli oluşturur.
POST/tunnels/bulk/http/custom-subdomainÖzel alt alan adlarıyla birden fazla tünel oluşturur.
POST/tunnels/bulk/http/custom-domainÖzel alan adlarında birden fazla tünel oluşturur.
POST/tunnels/bulk/tcp-udpBirden fazla TCP/UDP tüneli oluşturur.
POST/tunnels/bulk/proxyBirden fazla proxy tüneli oluşturur.
POST/tunnels/bulk/proxy/with-detailBirden fazla proxy tüneli oluşturur ve bağlantı ayrıntılarını döndürür.
POST/tunnels/bulk/shared-proxyBirden fazla paylaşılan (rotasyonlu) proxy tüneli oluşturur.
POST/tunnels/bulk/actions/startBirden fazla tüneli başlatır. Gövde: tünel kimliklerinden oluşan bir dizi, örneğin [123, 456].
POST/tunnels/bulk/actions/stopBirden fazla tüneli durdurur. Gövde: tünel kimliklerinden oluşan bir dizi.
DELETE/tunnels/bulkBirden fazla tüneli siler. Gövde: tünel kimliklerinden oluşan bir dizi.
PATCH/tunnels/bulk/protocol-typeBirden fazla proxy tünelinin proxy protokolünü değiştirir.

Tünel yapılandırması #

Bu uç noktalar tek bir tünelin ayarlarını değiştirir. Hepsi /tunnels/{tunnelId} ile başlar. Her ayarın ne yaptığı Ayarlar başvurusunda anlatılır.

Yöntemler/tunnels/{tunnelId} sonrasındaki yolAmaç
GET, POST, PATCH, DELETE/ip-restrictionsTüm IP kısıtlamalarını listeler, ekler, izin ver veya reddet modunu ayarlar ya da siler. Birini /ip-restrictions/{restrictionId} ile silin.
GET, POST, PATCH, DELETE/access-controlsURL yolu erişim denetimleri için aynısı. Birini /access-controls/{controlId} ile silin.
GET, PATCH/headersÖzel HTTP başlıkları.
GET, PATCH/authenticationHTTP Temel Kimlik Doğrulaması.
GET, PATCH/expirationTünelin son kullanma tarihi.
GET, PATCH/server-portBir TCP/UDP tünelinin sunucu tarafı portu.
GET, PATCH/http-timeoutHTTP istek zaman aşımı.
GET, PATCH/rate-limitHız sınırı.
GET, PATCH/bandwidth-limitToplam veri aktarımı sınırı.
GET/bandwidth-usageGüncel bant genişliği kullanımı. Sayacı POST /bandwidth-usage/reset ile sıfırlayın.
GET, PATCH/argumentsTünel için özel komut satırı bağımsız değişkenleri.
GET, POST/shared-proxy-clientsPaylaşılan (rotasyonlu) bir proxy tünelinin istemcilerini listeler veya ekler. Birini PATCH veya DELETE /shared-proxy-clients/{clientId} ile güncelleyin ya da silin.
GET/advanced-settingsTünelin tüm gelişmiş ayarları tek bir yanıtta.
GET, PATCH/ipv4-only, /wifi-split, /proxy-protocol, /pass-through, /https-only, /http3Bir gelişmiş ayarı okur veya değiştirir.
PATCH/ssl-streamSSL akışı ayarını değiştirir.
GET, PATCH/file-path, /host-header, /path-rewrite, /upstream-proxy, /note, /vlessBir değeri okur veya değiştirir.
GET, PUT/token-groupsTünele atanmış token grupları.
GET, PATCH/serverTünelin sunucusu.

AuthToken'lar #

YöntemYolAmaç
GET/auth-tokensAuthToken'larınızı listeler.
GET/auth-tokens/detailAuthToken'larınızı ayrıntılarıyla listeler.
GET/auth-tokens/{token}Bir AuthToken'ın ayrıntıları.
POST/auth-tokensBir AuthToken oluşturur.
DELETE/auth-tokens/{token}Bir AuthToken'ı siler.
GET/auth-tokens/{token}/tunnelsBir AuthToken'ın tünelleri.
GET/auth-tokens/{token}/ip-historyCihazın herkese açık IP adresi değişiklik geçmişi.
GET, PATCH/auth-tokens/{token}/airplane-mode-settingsUçak modu otomasyon ayarları.
POST/auth-tokens/{token}/change-ip-links/{airplaneModeSettingId}Bir IP değiştirme bağlantısı ekler.
DELETE/auth-tokens/{token}/change-ip-links/{id}Bir IP değiştirme bağlantısını siler.
POST/auth-tokens/{token}/restart-device-links/{airplaneModeSettingId}Bir cihaz yeniden başlatma bağlantısı ekler.
DELETE/auth-tokens/{token}/restart-device-links/{id}Bir cihaz yeniden başlatma bağlantısını siler.
GET, PATCH/auth-tokens/{token}/argumentsAuthToken üzerinde kayıtlı istemci bağımsız değişkenleri.

Token grupları #

YöntemYolAmaç
GET/token-groupsToken gruplarınızı listeler.
GET/token-groups/{id}Tek bir token grubunu getirir.
POST/token-groupsBir token grubu oluşturur.
DELETE/token-groups/{id}Bir token grubunu siler.
POST/token-groups/{id}/auth-tokensGruba bir AuthToken ekler.
DELETE/token-groups/{id}/auth-tokens/{tokenId}Bir AuthToken'ı gruptan çıkarır.

Sunucular #

YöntemYolAmaç
GET/serversTünel oluşturabileceğiniz sunucuları, oluşturma isteklerinde kullanılacak serverCode ile birlikte listeler.

SSO sağlayıcıları #

YöntemYolAmaç
GET/sso-providersSSO sağlayıcılarınızı listeler.
GET/sso-providers/default-endpointsBir SSO sağlayıcı türünün varsayılan uç noktaları.
POST/sso-providersBir SSO sağlayıcısı oluşturur veya günceller.
DELETE/sso-providers/{id}Bir SSO sağlayıcısını siler.
GET/sso-providers/tunnel/{tunnelId}Bir tünel için yapılandırılmış SSO sağlayıcıları. Burada tunnelId, tünelin GUID değeridir (guidId).
PUT/sso-providers/tunnel/{tunnelId}Bir tünelin SSO sağlayıcılarını kaydeder.

Sağlayıcıların ne yaptığını öğrenmek için Tek Oturum Açma sayfasına bakın.

VPN erişimi #

VPN erişimi, bir proxy tüneli üzerinde WireGuard veya OpenVPN cihaz profili verir; o cihazın tüm trafiği proxy üzerinden çıkar. Bu uç noktalar /tunnels/{tunnelId}/vpn-access ile başlar.

Yöntem/tunnels/{tunnelId}/vpn-access sonrasındaki yolAmaç
GET(yok)Tünelin VPN cihazlarını listeler.
POST(yok)Bir VPN cihazı oluşturur.
DELETE/{peerId}Bir VPN cihazını siler (iptal eder).
POST/{peerId}/regenerateBir VPN cihazının anahtarlarını yeniden oluşturur.
GET/{peerId}/configBir VPN cihazının yapılandırma dosyasını indirir.
GET/{peerId}/qrBir WireGuard cihaz yapılandırmasının QR kodu.
GET/{peerId}/credentialsBir OpenVPN cihazının kullanıcı adı ve parolası.

Sorun giderme #

Her istek 401 döndürüyor

Başlığı kontrol edin: Authorization: Bearer ve ardından bir boşluk ve anahtar olmalı, anahtarın etrafında tırnak bulunmamalıdır. API Anahtarı kartında Değiştir düğmesini seçtiyseniz eski anahtar artık çalışmaz; yenisini kopyalayın.

Ekibimin AuthToken'larını görmüyorum

Kendi hesabınızın API anahtarını kullanıyorsunuz. Ekip paneline geçin ve API anahtarını orada kopyalayın.

Tünel oluşturuldu ama adresi yanıt vermiyor

Yeni bir tünel durdurulmuş olarak gelir. POST /tunnels/{tunnelId}/actions/start çağrısını yapın ve cihazın Localtonet istemcisinin kullandığınız AuthToken ile çalıştığını kontrol edin.

429 Too Many Requests alıyorum

İstekler hız sınırına tabidir. Bekleyin, ardından isteği yeniden gönderin ve tekli çağrı döngülerini tek bir toplu istekle değiştirin.

Bu sayfa için yardıma mı ihtiyacınız var? Topluluğa sorun veya bir destek talebi açın.

Destek