簡介
外部控制功能可讓使用者透過 HTTP RESTful API 控制 Clash，第三方 Clash GUI 也以此功能為基礎。在 external-controller 中指定位址即可啟用。
認證
- 外部控制器接受
Bearer Tokens作為存取驗證方式。- 將
Authorization: Bearer <Your Secret>設為請求標頭，以傳遞驗證憑證。
- 將
RESTful API 文件
日誌
/logs- 方法：
GET- 完整路徑：
GET /logs - 描述：取得實時日誌
- 完整路徑：
- 方法：
流量
/traffic- 方法：
GET- 完整路徑：
GET /traffic - 描述：取得實時流量資料
- 完整路徑：
- 方法：
版本
/version- 方法：
GET- 完整路徑：
GET /version - 描述：取得 Clash 版本
- 完整路徑：
- 方法：
設定
/configs方法：
GET- 完整路徑：
GET /configs - 描述：取得基礎設定
- 完整路徑：
方法：
PUT- 完整路徑：
PUT /configs - 描述：重新載入設定檔
- 完整路徑：
方法：
PATCH- 完整路徑：
PATCH /configs - 描述：增量修改設定
- 完整路徑：
節點
/proxies- 方法：
GET- 完整路徑：
GET /proxies - 描述：取得所有節點資訊
- 完整路徑：
- 方法：
/proxies/:name方法：
GET- 完整路徑：
GET /proxies/:name - 描述：取得指定節點資訊
- 完整路徑：
方法：
PUT- 完整路徑：
PUT /proxies/:name - 描述：切換 Selector 中選中的節點
- 完整路徑：
/proxies/:name/delay- 方法：
GET- 完整路徑：
GET /proxies/:name/delay - 描述：取得指定節點的延遲測試資訊
- 完整路徑：
- 方法：
規則
/rules- 方法：
GET- 完整路徑：
GET /rules - 描述：取得規則資訊
- 完整路徑：
- 方法：
連線
/connections方法：
GET- 完整路徑：
GET /connections - 描述：取得連線資訊
- 完整路徑：
方法：
DELETE- 完整路徑：
DELETE /connections - 描述：關閉所有連線
- 完整路徑：
/connections/:id- 方法：
DELETE- 完整路徑：
DELETE /connections/:id - 描述：關閉指定連線
- 完整路徑：
- 方法：
代理集
/providers/proxies- 方法：
GET- 完整路徑：
GET /providers/proxies - 描述：取得所有代理集的代理資訊
- 完整路徑：
- 方法：
/providers/proxies/:name方法：
GET- 完整路徑：
GET /providers/proxies/:name - 描述：取得指定代理集的代理資訊
- 完整路徑：
方法：
PUT- 完整路徑：
PUT /providers/proxies/:name - 描述：切換指定代理集
- 完整路徑：
/providers/proxies/:name/healthcheck- 方法：
GET- 完整路徑：
GET /providers/proxies/:name/healthcheck - 描述：取得指定代理集的代理資訊
- 完整路徑：
- 方法：
DNS 查詢
/dns/query方法：
GET完整路徑：
GET /dns/query?name={name}[&type={type}]描述：取得指定網域和類型的 DNS 查詢資料
參數：
name（必填）：要查詢的網域type（選填）：要查詢的 DNS 記錄類型，例如 A、MX 或 CNAME。若未提供，預設為A。
範例：
GET /dns/query?name=example.com&type=A