HTTP Control API และคอนโซลเว็บ
[General]
external-http-controller = 127.0.0.1:9090
external-http-secret = your-secret-token
external-http-ui = true
external-http-cors = false
Chute มี HTTP Control API ในตัวและคอนโซลเว็บ คล้ายกับแดชบอร์ด Clash และ Surge API เปิดเผยสถานะเอนจิน ทราฟฟิก การเชื่อมต่อ DNS การควบคุมนโยบาย และการจัดการการกำหนดค่าผ่านจุดปลายทาง REST
http-api = <secret>@<host>:<port> ของ Surge จะถูกอ่านเป็น external-http-controller ร่วมกับ external-http-secret และยังสามารถเขียนแยกส่วนได้ด้วย: http-api-secret, http-api-ui, http-api-cors จะถูกอ่านเป็น external-http-secret, external-http-ui, external-http-cors ตามลำดับ และ http-api-web-dashboard ก็จะถูกอ่านเป็น external-http-ui เช่นกัน โดยการกำหนดค่าจะถูกบันทึกด้วยคีย์ external-http-* ส่วน http-api-tls ไม่รองรับ (ตัวควบคุมใช้ HTTP ธรรมดา) และจะมีเพียงข้อความแจ้ง
external-http-controller (ค่าเริ่มต้น: ปิดใช้งาน)
external-http-controller = 127.0.0.1:9090
คำขอที่คอนโซลเก็บค้างไว้ระหว่างให้บริการถูกจำกัดที่ 4 MB บน macOS และ 1 MB บน iOS, tvOS และ Android
ที่อยู่และพอร์ตของเซิร์ฟเวอร์ควบคุม HTTP ใช้ 127.0.0.1 สำหรับการเข้าถึงเฉพาะเครื่อง การผูกกับที่อยู่ที่ไม่ใช่ลูปแบ็ก (เช่น 192.168.1.5:9090) ต้องตั้ง external-http-secret อย่างชัดเจน มิฉะนั้นเซิร์ฟเวอร์จะปฏิเสธการเริ่มทำงานและบันทึกว่าขาดอะไร
ที่อยู่ไวลด์การ์ด (0.0.0.0, ::, *) นับเป็นไม่ใช่ลูปแบ็กในการตรวจนี้ เพราะมันรับฟังบนทุกอินเทอร์เฟซ ซึ่งตรงข้ามกับเฉพาะเครื่อง รูปแบบที่รับได้คือ 0.0.0.0:9090, *:9090 (ความหมายเดียวกัน) และสำหรับ IPv6 คือ [::]:9090 — เขียน :::9090 เปล่า ๆ ก็จะใส่วงเล็บเหลี่ยมให้เอง ส่วนที่อยู่ที่แยกวิเคราะห์ไม่ได้จะถูกรายงานเป็นข้อผิดพลาดของการกำหนดค่า แทนที่จะปล่อยให้ตัวควบคุมปิดอยู่เงียบ ๆ และช่วง 127.0.0.0/8 ทั้งหมดนับเป็นลูปแบ็ก ไม่ใช่แค่ 127.0.0.1
external-http-secret (ค่าเริ่มต้น: โทเคนที่สร้างให้)
external-http-secret = your-secret-token
โทเคน Bearer ที่ใช้ยืนยันตัวตนกับ API คำขอต้องมีส่วนหัว Authorization: Bearer <secret> โทเคนรับเฉพาะในส่วนหัวนี้เท่านั้น ไม่รับผ่านพารามิเตอร์คิวรี และเปรียบเทียบด้วยเวลาคงที่ การยืนยันตัวตนล้มเหลวคืนค่า 401 พร้อม {"ok": false, "error": {"code": "unauthorized", "message": "missing or invalid token"}} เส้นทางข้อมูลทุกเส้นถูกป้องกัน: เส้นทาง /api/*, ชื่อแฝงที่เข้ากันได้กับ Clash และเส้นทางแบบเก่าที่ตอนนี้มีเฉพาะบน Chute Android (/status, /policies, /dns, /records เป็นต้น) ซึ่งก็รับโทเคนเฉพาะในส่วนหัวนี้เช่นกัน ส่วนแดชบอร์ดระยะไกลของ Chute Android เองตอนนี้ใช้เฉพาะเส้นทาง /api/* หน้าเว็บและไฟล์สแตติกของคอนโซลเว็บ (/, /assets/… และบน Chute Android รวมถึง /ui) ไม่ต้องใช้โทเคน (เมื่อ external-http-ui = false จะหายไปทั้งหมด — หน้าเว็บตอบ 404)
เมื่อไม่ได้ระบุคีย์นี้ Chute จะสร้างโทเคนให้ แทนที่จะให้บริการโดยไม่ยืนยันตัวตน โทเคนที่สร้างขึ้นจะถูกเขียนลงไฟล์ control-token ในโฟลเดอร์แชร์ของ Chute — ไม่ใช่ข้างไฟล์การกำหนดค่า: บน iOS และ tvOS คือคอนเทนเนอร์ของ App Group ส่วนบน Android คือไดเรกทอรีข้อมูลส่วนตัวของแอป — ด้วยสิทธิ์ที่เจ้าของอ่านได้เท่านั้น ถูกใช้ต่อหลังรีสตาร์ต และแอปจะแสดงให้คุณเห็น — ดูการเปิดคอนโซลเว็บ API ควบคุมสามารถส่งมอบฐานข้อมูลการเชื่อมต่อ ซึ่งบันทึกไว้ทุก URL ทุกส่วนหัว และทุกชื่อกระบวนการที่เห็นในรอบการทำงานนี้ การเปิดทิ้งไว้จึงไม่ใช่ค่าเริ่มต้นที่สมเหตุสมผล
หากยังต้องการให้บริการโดยไม่ยืนยันตัวตน ให้ระบุอย่างชัดเจนในไฟล์การกำหนดค่า:
external-http-secret = none
ค่านี้ได้รับการยอมรับเฉพาะเมื่อผูกกับลูปแบ็กเท่านั้น นอกลูปแบ็ก ทั้ง none และการไม่ระบุคีย์ล้วนไม่พอ เซิร์ฟเวอร์ควบคุมจะปฏิเสธการเริ่มทำงานและบอกว่าต้องการอะไร
หมายเหตุการอัปเกรด: หากคุณเคยอาศัยว่า "ไม่มี
external-http-secretเท่ากับไม่ยืนยันตัวตน" สคริปต์ในเครื่องจะเริ่มได้รับ401ให้อ่านโทเคนที่สร้างขึ้นจากแอป หรือเขียนexternal-http-secret = noneเพื่อคงพฤติกรรมเดิมไว้อย่างตั้งใจ
external-http-ui (ค่าเริ่มต้น: true)
external-http-ui = true
เมื่อเปิดใช้งาน Chute ให้บริการคอนโซลเว็บในตัวที่ที่อยู่ของตัวควบคุม คอนโซลเว็บมีภาพรวม การจัดการการเชื่อมต่อ การตรวจสอบ DNS การตรวจสอบทราฟฟิก การควบคุมนโยบาย และการแก้ไขการกำหนดค่า ตั้งค่าเป็น false เพื่อให้ API เปิดใช้งานในขณะที่ปิดใช้งาน UI
การเปิดคอนโซลเว็บ
คอนโซลให้บริการที่ที่อยู่ของเซิร์ฟเวอร์ควบคุม และแต่ละแอปสามารถส่งที่อยู่กับโทเคนให้คุณได้ — รวมถึงโทเคนที่ระบบสร้างให้ ซึ่งมิฉะนั้นคุณจะไม่มีทางอ่านได้เลย:
- Chute Mac: แถบเมนู → เปิดคอนโซลเว็บ และ คัดลอกโทเคนคอนโซลเว็บ หน้าต่างรายละเอียดการเชื่อมต่อยังมี คำขอและประวัติ ซึ่งเปิดคอนโซลเช่นกัน — เปิดหน้าแรก ไม่ใช่การเชื่อมต่อนั้น
- Chute iOS: แผงควบคุม → แถวคอนโซลเว็บ → เปิด, คัดลอกที่อยู่ หรือ คัดลอกโทเคนการเข้าถึง
- Chute tvOS: แผงควบคุมมีแถว ที่อยู่คอนโซลเว็บ แยกต่างหาก แสดงโฮสต์และพอร์ต เมื่อเลือก ถ้าตัวรับฟังเข้าถึงได้จากอุปกรณ์อื่นจะแสดง QR Code — โทเคนลงชื่อเข้าใช้อยู่ในโค้ด ไม่แสดงบนหน้าจอ — แต่ถ้าตัวควบคุมผูกกับลูปแบ็ก จะแสดงคำอธิบายแทน เพราะคอนโซลบนลูปแบ็กเปิดจากโทรศัพท์ไม่ได้
- Chute Android: แผงควบคุม → ที่อยู่คอนโซลเว็บ → เปิด หรือ คัดลอกที่อยู่ และแถว โทเค็นการเข้าถึงที่สร้างขึ้น ซึ่งแตะเพื่อคัดลอก ทั้งสองแถวจะไม่ปรากฏเมื่อโทเคนเป็นค่าลับที่คุณกำหนดเอง ซึ่งจะไม่ถูกแสดงเลย
ที่อยู่ที่ได้จะพ่วงโทเคนมาในพารามิเตอร์คิวรี หน้าเว็บจะใช้มันตอนโหลดแล้วลบออกจากแถบที่อยู่ ดังนั้นการเปิดลิงก์คือการลงชื่อเข้าใช้ที่สมบูรณ์ ไม่มีใครต้องพิมพ์อักขระฐานสิบหก 32 ตัวด้วยมือ
external-http-cors (ค่าเริ่มต้น: false)
external-http-cors = true
เปิดใช้งานส่วนหัว CORS (Cross-Origin Resource Sharing) ในการตอบกลับ API มีประโยชน์เมื่อคอนโซลเว็บหรือเครื่องมือบุคคลที่สามต้องการเข้าถึง API จากต้นทางที่แตกต่างกัน
จุดปลายทาง API:
| เมธอด | จุดปลายทาง | คำอธิบาย |
|---|---|---|
GET |
/api/status |
สถานะรันไทม์ พอร์ต เวลาทำงาน |
GET |
/api/traffic |
ตัวนับทราฟฟิกส่วนกลางและต่อนโยบาย |
GET |
/api/connections |
การเชื่อมต่อที่ใช้งานปัจจุบัน |
DELETE |
/api/connections/:id |
ปิดการเชื่อมต่อ |
GET |
/api/connections/history |
ระเบียนการเชื่อมต่อในอดีต |
GET |
/api/connections/processes |
สถิติการเชื่อมต่อแยกตามกระบวนการ |
GET |
/api/connections/:id/request |
ข้อมูลคำขอที่บันทึกไว้ของการเชื่อมต่อ |
GET |
/api/connections/:id/response |
ข้อมูลการตอบกลับที่บันทึกไว้ของการเชื่อมต่อ |
GET |
/api/dns |
ระเบียนแคช DNS |
DELETE |
/api/dns/cache |
ล้างแคช DNS |
DELETE |
/api/dns/records/:domain |
ลบระเบียน DNS รายการเดียว |
GET |
/api/config |
การกำหนดค่าปัจจุบัน |
PUT |
/api/config |
โหลดการกำหนดค่าใหม่ |
POST |
/api/config/validate |
แยกวิเคราะห์การกำหนดค่าและรายงานข้อผิดพลาด โดยไม่โหลดมัน |
GET |
/api/policies |
กลุ่มนโยบายและการเลือกปัจจุบัน แต่ละรายการมี hidden ซึ่งเป็น true สำหรับกลุ่มที่ตั้ง hidden=true |
PUT |
/api/policies/:group |
เปลี่ยนการเลือกกลุ่มนโยบาย |
PUT |
/api/mode |
ตั้งค่าโหมดขาออก |
GET |
/api/features |
สถานะสวิตช์คุณสมบัติ |
PUT |
/api/features/mitm |
สลับ MitM |
PUT |
/api/features/record-traffic |
สลับการบันทึกทราฟฟิก |
GET |
/api/rules |
ตารางกฎที่ตัวจับคู่ไล่ตรวจจริง ที่มาของแต่ละกฎ และกฎการเขียนใหม่ที่ทำงานไปแล้ว |
POST |
/api/rules/match |
คำขอจะถูกกำหนดเส้นทางไปที่ใด โดยไม่ต้องส่งจริง |
GET |
/api/rules/user |
กฎที่เพิ่มขณะทำงาน ซึ่งจับคู่ก่อนโมดูลและการกำหนดค่า |
PUT |
/api/rules/user |
แทนที่กฎที่เพิ่มขณะทำงาน |
POST |
/api/rules/user |
เพิ่มกฎต่อท้ายกฎที่เพิ่มขณะทำงาน |
DELETE |
/api/rules/user |
ลบกฎที่เพิ่มขณะทำงานทั้งหมด |
GET |
/api/logs |
รายการบันทึกล่าสุด |
GET |
/api/loglevel |
ระดับบันทึกปัจจุบัน และส่วนที่กำลังเขียน |
PUT |
/api/loglevel |
เปลี่ยนระดับบันทึกหรือส่วนโดยไม่ต้องรีสตาร์ต |
GET |
/api/health |
สุขภาพของเอนจิน: จำนวนการปฏิเสธ รุ่น หน่วยความจำ และการออกครั้งก่อน |
GET |
/api/events |
เหตุการณ์สำคัญของรอบการทำงานนี้ |
GET |
/api/tailscale |
สถานะปัจจุบันของเอนจิน Tailscale |
GET |
/api/scripts |
สคริปต์แบบ generic ที่สั่งรันได้ตามต้องการ |
POST |
/api/scripts/run |
รันสคริปต์ generic หนึ่งตัวตามชื่อ |
POST |
/api/diagnostics/ping |
ตรวจการเข้าถึงด้วย ICMP หรือ TCP |
POST |
/api/diagnostics/dns-query |
แปลงชื่อโดเมนผ่านรีโซลเวอร์ที่กำลังทำงาน |
POST |
/api/diagnostics/egress-probe |
ตรวจที่อยู่: บนเอนจินของ Apple คือที่อยู่ของอุปกรณ์เอง บน Android คือที่อยู่สาธารณะของอุปกรณ์บนเครือข่ายกายภาพ ไม่ใช่ที่อยู่ขาออกของพร็อกซี |
POST |
/api/diagnostics/internet-test |
การทดสอบอินเทอร์เน็ตแบบตรง: ดึง internet-test-url โดยไม่ผ่านพร็อกซี |
POST |
/api/diagnostics/url-test/:policy |
รันการทดสอบความหน่วงของนโยบาย |
POST |
/api/diagnostics/bundle |
สร้างไฟล์เก็บถาวรวินิจฉัยที่ลบข้อมูลอ่อนไหวแล้ว |
GET |
/api/connections/export |
ส่งออกการเชื่อมต่อเป็น HAR 1.2 |
GET |
/api/rewrites |
ทุกตระกูลการเขียนใหม่/การตอบกลับจำลอง และรายการโฮสต์ MitM |
GET |
/api/rewrites/:family |
กฎของตระกูลหนึ่ง |
POST |
/api/rewrites/:family |
เพิ่มกฎ |
DELETE |
/api/rewrites/:family/:id |
ลบกฎ |
DELETE |
/api/rewrites/:family |
ล้างตระกูล |
GET |
/api/mitm/hosts |
โฮสต์ที่กำลังถอดรหัสอยู่ |
POST |
/api/mitm/hosts |
เพิ่มโฮสต์ |
DELETE |
/api/mitm/hosts/:host |
ลบโฮสต์ |
DELETE |
/api/mitm/hosts |
ล้างรายการ |
GET |
/api/rules/providers |
ผู้ให้บริการกฎและชุดกฎ พร้อมสถานะของแต่ละรายการ — รวมถึงเหตุผลที่บางรายการโหลดไม่สำเร็จ |
หมายเหตุจุดปลายทาง:
GET /api/featuresรายงานสวิตช์แต่ละตัวตามที่ตั้งไว้ —record_traffic,mitm,mitm_h2,mitm_auto_quic_block,rewrite— และlicensedส่วนeffectiveบอกว่าอะไรทำงานอยู่จริง สำหรับห้ารายการเท่านั้น:record_traffic,mitm,rewrite,scriptsและlan_proxyในรุ่นฟรีทั้งห้ารายการเป็นเท็จ สวิตช์จึงอาจอ่านได้ว่าเปิดอยู่ขณะที่รายการeffectiveของมันเป็นเท็จinactiveเป็นออบเจ็กต์ที่ระบุสิ่งที่การกำหนดค่าที่กำลังทำงานขอไว้แต่ไม่ทำงานในรุ่นนี้: จำนวนscripts,scriptRules,dnsScripts,rewritesและmapLocalsและแฟล็กmitm,bodyCapture,lanProxyและexitNode(การประกาศของ Tailscale ซึ่งมีเฉพาะ Chute Mac) เมื่อมีใบอนุญาต หรือขณะที่เอนจินหยุดอยู่ ทุกจำนวนจะเป็น 0 และทุกแฟล็กเป็นเท็จGET /api/connectionsรับlimit(จำนวนเต็มบวก ค่าเริ่มต้นและสูงสุด 1000) และcursor(ส่งคืนเฉพาะการเชื่อมต่อที่มีidมากกว่าเคอร์เซอร์)dataในการตอบกลับประกอบด้วยconnections,total,page_size,has_more,server_timeและ — เมื่อมีหน้าเพิ่มเติม —next_cursorส่วนsince(วินาที ซึ่งคือserver_timeของคำตอบก่อนหน้า) จะส่งคืนเฉพาะการเชื่อมต่อที่เปลี่ยนแปลงหลังจากเวลานั้น และเพิ่มactive_idsซึ่งเป็น id ของทุกการเชื่อมต่อที่เปิดอยู่ขณะนี้: การเชื่อมต่อที่คำตอบก่อนหน้ามีแต่ไม่อยู่ในรายการนี้คือการเชื่อมต่อที่ปิดไปแล้วsinceที่มากกว่าserver_timeจะถูกถือเป็น0จึงส่งคืนทุกการเชื่อมต่อGET /api/connections/historyรับlimit(ค่าเริ่มต้น 100 สูงสุด 1000) และcursor/before(ชื่อพ้องกัน; การส่งทั้งสองพร้อมกันจะถูกปฏิเสธ)GET /api/connections/:id/requestและ.../responseส่งคืน{"connection_id": <id>, "data": "<base64>"}ข้อมูลที่บันทึกไว้ที่ใหญ่กว่า 2 MiB ส่งคืน413หากไม่มี Chute Pro ทั้งสองจะส่งคืน403พร้อมrequest data is not availableหรือresponse data is not availableแม้กับเนื้อหาที่บันทึกไว้ระหว่างการทำงานรอบก่อนที่มีใบอนุญาตก็ตามGET /api/configส่งคืนการกำหนดค่าที่กำลังทำงานตามที่เขียนไว้ รวมถึงข้อมูลรับรอง —http-auth,external-http-secret,ca-p12,ca-passphrase, คีย์ WireGuard และรหัสผ่านของพร็อกซีทุกตัว — ดังนั้นการเข้าถึง API ควบคุมได้ก็เท่ากับเข้าถึงข้อมูลเหล่านี้ทั้งหมด มีเพียงชุดข้อมูลวินิจฉัยเท่านั้นที่แทนที่ข้อมูลรับรองด้วย<redacted>และสำเนานั้นโหลดกลับเข้าไปไม่ได้: การกำหนดค่าที่ส่งไปยังPUT /api/configซึ่งยังมี<redacted>อยู่ที่ใดก็ตามจะถูกปฏิเสธด้วย400พร้อมข้อความที่ระบุบรรทัดแรกที่เป็นเช่นนั้น ให้ส่งการกำหนดค่าต้นฉบับแทนGETและPUT /api/configเข้าถึงได้ในชื่อ/api/configsด้วย และในชื่อแฝงแบบ Clash/configsPUT /api/configรับได้ทั้ง JSON{"configuration": "<full text>"}หรือข้อความการกำหนดค่าดิบเป็นเนื้อหาคำขอ (จำกัด 1 MB) เมื่อสำเร็จ เอนจินจะโหลดใหม่ — หรือเริ่มทำงานหากยังไม่ได้รันPUT /api/policies/:groupนำการเลือกจากคีย์แรกที่พบในเนื้อหาคำขอตามลำดับpolicy,name,selected,select; ค่าอาจเป็นชื่อนโยบายหรือดัชนีตัวเลขในรูปสตริง ชื่อกลุ่มพิเศษGLOBALตั้งค่านโยบายที่เลือกแบบสากล- ใน
GET /api/policiesทุกนโยบาย กลุ่ม และสมาชิกของกลุ่มจะมีendpointซึ่งคือนโยบายที่มันนำไปถึงในขณะนี้ — ไล่ผ่านกลุ่มต่าง ๆ และผ่านPROXYในตัวไปยังนโยบายที่เลือกไว้สำหรับโหมดสากล — และendpoint_pingซึ่งคือความหน่วงของนโยบายนั้นpingของกลุ่มเองเป็น0เพราะไม่ได้วัด ดังนั้นendpoint_pingคือค่าที่ควรอ่านสำหรับกลุ่มหรือสำหรับPROXY PUT /api/modeต้องการตัวเลข JSON:{"mode": 0}—0ตามกฎ,1ตรง,2พร็อกซีPUT /api/features/mitmและPUT /api/features/record-trafficรับ{"enabled": true}GET /api/logsรับsince(วินาที Unix); บัฟเฟอร์ในหน่วยความจำเก็บรายการล่าสุด 1000 รายการ แต่ละรายการเป็น{timestamp, wall_time, level, section, message}—timestampและwall_timeมีค่าวินาที Unix เดียวกัน และถูกขยับไปข้างหน้าเมื่อนาฬิกาไม่เดิน เพื่อให้ลำดับของรายการเรียงกันอย่างเคร่งครัดGET /api/healthรายงานว่าเอนจินกำลังถืออะไรอยู่ ปฏิเสธอะไรครั้งล่าสุดเพราะอะไร และรอบก่อนหน้าจบลงอย่างไร (clean,uncleanหรือsuspected_memory— ดูการแก้ไขปัญหา)addressFamilyบอกว่า Chute ตัดสินทางออก IPv6 อย่างไร —ipv6เป็นhealthy,confirmingหรือdegraded— พร้อมจำนวนของสิ่งที่ Chute ทำไปเพื่อรับมือ บนเอนจินของ AppleselfLoopรายงานตัวป้องกันการวนกลับเข้าตัวเอง ทั้งสองไม่มีที่อยู่ใด ๆ อยู่ภายในGET /api/eventsให้บัฟเฟอร์วงแหวนในหน่วยความจำ ส่วน?persisted=1อ่านประวัติที่บันทึกไว้ของรอบนี้แทน และตอบavailable: falseเมื่อปิดการบันทึก- เมื่อไม่ได้กำหนดส่วน
[Tailscale]GET /api/tailscaleจะตอบstate: "idle"ซึ่งเป็นคำตอบปกติ ไม่ใช่ข้อผิดพลาด - การตรวจ
POST /api/diagnostics/*รับอาร์กิวเมนต์จากคิวรีสตริงหรือ JSON body มีขีดจำกัดสิบวินาที และตอบเพียงครั้งเดียวurl-test/:policyจะปฏิเสธชื่อนโยบายที่ไม่มีอยู่ แทนที่จะไปวัดREJECT GET /api/scriptsแสดงรายการสคริปต์ generic ที่เปิดใช้งานอยู่ในรูป{name, type}ส่วนPOST /api/scripts/runรับnameจากเนื้อหาคำขอหรือคิวรีสตริง มีขีดจำกัดเวลาเหมือนการตรวจวินิจฉัย และตอบ{name, timedOut, result}—timedOutแยกสคริปต์ที่ไม่เคยเรียก$doneออกจากสคริปต์ที่ทำงานจนจบ ชื่อที่ไม่ใช่สคริปต์ generic ที่เปิดใช้งานอยู่จะได้404หากไม่มี Chute Pro จะตอบ403พร้อมscript is not availablePOST /api/rules/matchตอบว่าคำขอจะไปที่ใด โดยไม่เปิดการเชื่อมต่อ มันรับhost(หรือurlเพื่อดึงโฮสต์และพอร์ตมา ซึ่งกฎURL-REGEXจะถูกทดสอบกับurlนี้ตามที่เขียนไว้ทุกตัวอักษร แม้ในทราฟฟิกจริงกฎนี้จะเห็นเพียงคำขอhttp://ธรรมดาเท่านั้น),port(ค่าเริ่มต้น 443) และตัวเลือกเสริมip,protocol,process,process_path,src_ip,src_port,in_port,in_type,in_user,in_name,network,ssid,bssid,from_tun,user_agent— ฟิลด์ที่ไม่รู้จักจะถูกปฏิเสธพร้อมรายการที่ยอมรับ ไม่ใช่ถูกเพิกเฉย คำตอบมีกฎmatched(บรรทัดกฎ ชนิด นโยบายที่มันระบุ และresolved_policyที่กลุ่มกำลังชี้อยู่),policy,need_resolveและrule_countกับmatch_generationที่ใช้คำนวณ เนื่องจากโดเมนถูกจับคู่สองครั้ง — ครั้งหนึ่งด้วยชื่อ และอีกครั้งเมื่อรู้ที่อยู่แล้ว —passesจึงมีหนึ่งรายการต่อหนึ่งรอบ ถ้าไม่ส่งipมาจะมีเฉพาะรอบก่อนการแปลง และคำตอบจะบอกไว้ในnoteเพิ่มexplain=trueเพื่อดูกฎที่อาจตรงได้เช่นกันสูงสุด 50 ข้อ พร้อมจำนวนชุดกฎที่ไม่ได้กางออกPOST /api/config/validateแยกวิเคราะห์การกำหนดค่าแล้วทิ้ง: เอนจินที่กำลังทำงานไม่รับอะไรไปเลย ส่งเป็น{"configuration": "<full text>"}หรือส่งข้อความดิบก็ได้ คำตอบคือvalid,error_count,advisory_count,rule_count,policy_countและรายการerrorsที่มี{line, severity, content, error}—severityแยกบรรทัดที่ถูกปฏิเสธออกจากบรรทัดที่ยอมรับพร้อมข้อความแจ้ง และcontentคือบรรทัดที่มีปัญหาตามที่เขียนไว้ รวมถึงข้อมูลรับรอง เพราะบรรทัด[Proxy]ที่ผิดมักผิดตรงฟิลด์ที่เก็บรหัสผ่านของมันพอดี — โดยตัดไว้ที่ 4096 อักขระ ใช้มันก่อนPUT /api/configซึ่งจะรีสตาร์ตรอบการทำงานที่คุณกำลังดีบักอยู่GET /api/loglevelรายงานlevelปัจจุบัน,nslog_level,sectionsที่กำลังเขียนลงไฟล์ และavailable_levels/available_sectionsที่คุณตั้งได้ ส่วนPUT(หรือPATCH) รับlevel,sectionsหรือทั้งคู่:sectionsเป็นอาร์เรย์ของชื่อส่วนหรือสตริง"all"และอาร์เรย์ว่างจะถูกปฏิเสธ — ถ้าจะหยุดบันทึกให้ใช้levelเป็นnoneการเปลี่ยนระดับด้วยวิธีนี้ไม่รีสตาร์ตรอบการทำงาน ซึ่งเป็นประเด็นสำคัญ:loglevel = verboseในไฟล์ต้องโหลดใหม่ และการโหลดใหม่จะทำให้สิ่งที่คุณพยายามจะดูหายไปGET /api/rulesยังรายงานrewrite_hitsด้วย — ทุกกฎเขียนใหม่หรือกฎการตอบกลับจำลองที่ทำงานในรอบนี้พร้อมจำนวนครั้ง กฎที่ไม่ปรากฏตรงนั้นคือกฎที่ไม่เคยตรงเลย ซึ่งเป็นคำอธิบายที่พบบ่อยที่สุดของการเขียนใหม่ที่ดูเหมือนไม่ทำอะไร ตารางนี้ติดตามกฎที่ต่างกันได้สูงสุด 512 กฎ และรายงานส่วนที่เกินในrewrite_hit_dropped_rulesrulesจะแสดงทุกกฎที่ตัวจับคู่ไล่ตรวจตามลำดับ: กฎอัตโนมัติของ Tailscale ตามด้วยกฎที่เพิ่มผ่าน/api/rules/userแล้วกฎของโมดูล แล้วจึงเป็นส่วน[Rule]ของการกำหนดค่า และปิดท้ายด้วยFINALส่วนrule_regionsจะบอกที่มาของแต่ละบรรทัดตามดัชนีเดียวกัน (front,user,module,configuration)/api/rules/userเก็บกฎที่เพิ่มขณะเอนจินทำงาน โดยไม่ต้องโหลดซ้ำและไม่แตะไฟล์การกำหนดค่า กฎเหล่านี้จะถูกจับคู่หลังกฎอัตโนมัติของ Tailscale และก่อนกฎของโมดูลและส่วน[Rule]ของการกำหนดค่า ตามลำดับที่ให้มาGETแสดงรายการกฎPUTแทนที่กฎ และPOSTเพิ่มกฎต่อท้ายกฎที่มีอยู่ ทั้งสองรับ{"rules": ["<rule line>", ...]}หรือ{"rule": "<rule line>"}เดี่ยว ซึ่งเขียนแบบเดียวกับในไฟล์ ส่วนDELETEลบกฎทั้งหมด การเขียนเป็นแบบทั้งหมดหรือไม่มีเลย: บรรทัดที่แยกวิเคราะห์ไม่ได้ หรือFINALจะถูกปฏิเสธด้วย400และกฎจะคงอยู่เหมือนเดิม กฎที่ใช้นโยบายซึ่งการกำหนดค่าที่กำลังทำงานไม่ได้กำหนดไว้จะถูกรับไว้ — โดยจะปฏิเสธการเชื่อมต่อด้วยREJECT(fail closed) — และถูกระบุในwarningsส่วนclose_reroutedซึ่งเป็นtrueโดยค่าเริ่มต้น จะปิดการเชื่อมต่อที่กฎที่เปลี่ยนไปส่งไปเส้นทางอื่น และเฉพาะการเชื่อมต่อเหล่านั้นเท่านั้นfalseจะปล่อยให้ทุกการเชื่อมต่อเปิดอยู่ — สำหรับDELETEให้ส่งเป็น?close_rerouted=falseทุกเมธอดตอบกลับด้วยrulesปัจจุบัน กฎเหล่านี้คงอยู่หลังการโหลดซ้ำ และหายไปเมื่อเอนจินหยุด เส้นทางนี้ไม่รับPATCHPOST /api/rewrites/:familyรับ{"rule": "<configuration line>"}— ข้อความเดียวกับที่คุณจะเขียนในไฟล์ บรรทัดที่แยกวิเคราะห์ไม่ได้จะถูกปฏิเสธด้วย400แทนที่จะถูกเก็บเป็นกฎที่ไม่มีวันตรง:familyเป็นหนึ่งในurl-rewrite,header-rewrite,body-rewrite,mockกฎที่เพิ่มด้วยวิธีนี้อยู่ในเอนจินที่กำลังทำงานเท่านั้น และจะไม่ถูกเขียนกลับลงไฟล์การกำหนดค่าGET /api/connections/export?format=harคืน เอกสาร HAR 1.2 และPOST /api/diagnostics/bundleคืนไฟล์ zip — ทั้งคู่เป็นไฟล์ จึงไม่ถูกห่อด้วย{"ok": ..., "data": ...}ต่างจากทุกจุดปลายทางอื่นexportรับsource(currentเป็นค่าเริ่มต้น หรือhistory),limit(ค่าเริ่มต้น 100 สูงสุด 300),idsและbodies=1เพื่อรวมเพย์โหลดที่จับไว้ แต่ละรายการมีอ็อบเจกต์_klบรรจุสิ่งที่ HAR ไม่มีฟิลด์รองรับ ได้แก่ นโยบายที่เลือก กฎที่ตรง และการเขียนใหม่ที่ทำงาน- ระเบียนของการเชื่อมต่อที่ต่อพ่วงใน
GET /api/connectionsและGET /api/connections/historyมีchainPathคือเส้นทางจากอุปกรณ์นี้ถึงทางออก เช่นAirport/HK-01 → Landingค่าจะว่างสำหรับการเชื่อมต่อที่ใช้นโยบายเดียว และการส่งออก HAR เก็บไว้ใน_kl.chainในตัวนับรายนโยบายของGET /api/trafficอัปสตรีมจะนับไบต์ที่รับส่งให้การเชื่อมต่อที่ต่อพ่วงด้วย ส่วนยอดรวมทั้งหมดนับเพียงครั้งเดียว
ตัวอย่าง — อ่านสถานะ จากนั้นสลับกลุ่มนโยบาย:
curl -H "Authorization: Bearer your-secret-token" http://127.0.0.1:9090/api/status
{"ok":true,"data":{"running":true,"outbound_mode":0,"mitm":false, ...}}
curl -X PUT -H "Authorization: Bearer your-secret-token" \
-d '{"policy": "ProxyB"}' http://127.0.0.1:9090/api/policies/MainGroup
{"ok":true,"data":{"outbound_mode":0,"selectable_groups":[...], ...}}
ตัวอย่าง — ถามว่าคำขอจะไปที่ใดก่อนจะส่งจริง:
curl -X POST -H "Authorization: Bearer your-secret-token" \
-d '{"url": "https://api.example.com/v1/orders", "explain": true}' \
http://127.0.0.1:9090/api/rules/match
{"ok":true,"data":{"policy":"MainGroup","matched":{"rule":"DOMAIN-SUFFIX,example.com,MainGroup", ...}, ...}}
จำกัดบันทึกให้เหลือระบบย่อยเดียวขณะทำซ้ำปัญหา โดยไม่ต้องรีสตาร์ตรอบการทำงาน:
curl -X PUT -H "Authorization: Bearer your-secret-token" \
-d '{"level": "verbose", "sections": ["MitM", "DNS"]}' \
http://127.0.0.1:9090/api/loglevel
หมายเหตุ: คุณสมบัตินี้ถูกปิดใช้งานโดยค่าเริ่มต้น ทุกการตอบกลับใช้รูปแบบครอบ (envelope)
{"ok": true, "data": {...}}เมื่อสำเร็จและ{"ok": false, "error": {"code": "...", "message": "..."}}เมื่อเกิดข้อผิดพลาด; เนื้อหาคำขอถูกจำกัดที่ 1 MBปลายทาง
PUTยังรับPATCHด้วย มีพาธชื่อแฝงที่เข้ากันได้กับ Clash สำหรับแดชบอร์ดจากบุคคลที่สาม:/version,/traffic,/connections,/configs,/proxies,/rules— พาธเหล่านี้เข้าถึงได้ แต่การตอบกลับใช้รูปแบบครอบและชื่อฟิลด์ของ Chute แทน schema ของ Clash (/versionส่งคืน{"name", "run_id", "egress_probe"}โดยegress_probeเป็นnetwork_addressบนเอนจินของ Apple และegress_ipบนเอนจินของ Android) ดังนั้นแดชบอร์ด Clash จะไม่สามารถใช้ได้ทันที
หน้านี้เป็นฉบับแปลจากเวอร์ชันภาษาอังกฤษ หากเนื้อหาไม่ตรงกัน ให้ยึดเวอร์ชันภาษาอังกฤษเป็นหลัก